dapla-toolbelt-metadata 0.2.1__py3-none-any.whl → 0.9.11__py3-none-any.whl

dapla_metadata/variable_definitions/_generated/vardef_client/docs/PublicApi.md

@@ -0,0 +1,218 @@
+# vardef_client.PublicApi
+
+All URIs are relative to *https://metadata.intern.test.ssb.no*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_public_variable_definition_by_id**](PublicApi.md#get_public_variable_definition_by_id) | **GET** /public/variable-definitions/{variable-definition-id} | Get one variable definition.
+[**list_public_validity_periods**](PublicApi.md#list_public_validity_periods) | **GET** /public/variable-definitions/{variable-definition-id}/validity-periods | List all validity periods.
+[**list_public_variable_definitions**](PublicApi.md#list_public_variable_definitions) | **GET** /public/variable-definitions | List all variable definitions.
+
+
+# **get_public_variable_definition_by_id**
+> get_public_variable_definition_by_id(variable_definition_id, accept_language, date_of_validity=date_of_validity)
+
+Get one variable definition.
+
+Get one variable definition. This is rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PublicApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+    date_of_validity = '' # date | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # Get one variable definition.
+        api_instance.get_public_variable_definition_by_id(variable_definition_id, accept_language, date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling PublicApi->get_public_variable_definition_by_id: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+ **date_of_validity** | **date**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+**404** | No such variable definition found |  -  |
+
+[[Back to top]](#) [[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_public_validity_periods**
+> list_public_validity_periods(variable_definition_id, accept_language)
+
+List all validity periods.
+
+List all validity periods. These are rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PublicApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+
+    try:
+        # List all validity periods.
+        api_instance.list_public_validity_periods(variable_definition_id, accept_language)
+    except Exception as e:
+        print("Exception when calling PublicApi->list_public_validity_periods: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+
+[[Back to top]](#) [[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_public_variable_definitions**
+> list_public_variable_definitions(accept_language, date_of_validity=date_of_validity)
+
+List all variable definitions.
+
+List all variable definitions. These are rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PublicApi(api_client)
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+    date_of_validity = '' # str | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # List all variable definitions.
+        api_instance.list_public_variable_definitions(accept_language, date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling PublicApi->list_public_variable_definitions: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+ **date_of_validity** | **str**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/SupportedLanguages.md

@@ -0,0 +1,15 @@
+# SupportedLanguages
+
+Languages the application supports.
+
+## Enum
+
+* `NB` (value: `'nb'`)
+
+* `NN` (value: `'nn'`)
+
+* `EN` (value: `'en'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/UpdateDraft.md

@@ -0,0 +1,44 @@
+# UpdateDraft
+
+Update variable definition Data structure with all fields optional for updating a Draft Variable Definition.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**LanguageStringType**](LanguageStringType.md) | Name of the variable. Must be unique for a given Unit Type and Owner combination. | [optional]
+**short_name** | **str** | Recommended short name. Must be unique within an organization. | [optional]
+**definition** | [**LanguageStringType**](LanguageStringType.md) | Definition of the variable. | [optional]
+**classification_reference** | **str** | ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable. | [optional]
+**unit_types** | **List[str]** | A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702. | [optional]
+**subject_fields** | **List[str]** | A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618. | [optional]
+**contains_special_categories_of_personal_data** | **bool** | True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation | [optional]
+**variable_status** | [**VariableStatus**](VariableStatus.md) | Status of the life cycle of the variable | [optional]
+**measurement_type** | **str** | Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303 | [optional]
+**valid_from** | **date** | The variable definition is valid from this date inclusive | [optional]
+**external_reference_uri** | **str** | A link (URI) to an external definition/documentation | [optional]
+**comment** | [**LanguageStringType**](LanguageStringType.md) | Optional comment to explain the definition or communicate potential changes. | [optional]
+**related_variable_definition_uris** | **List[str]** | Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc. | [optional]
+**owner** | [**Owner**](Owner.md) | Owner of the definition, i.e. responsible Dapla team (statistics team) and information about access management groups. | [optional]
+**contact** | [**Contact**](Contact.md) | Contact details | [optional]
+
+## Example
+
+```python
+from vardef_client.models.update_draft import UpdateDraft
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UpdateDraft from a JSON string
+update_draft_instance = UpdateDraft.from_json(json)
+# print the JSON string representation of the object
+print(UpdateDraft.to_json())
+
+# convert the object into a dict
+update_draft_dict = update_draft_instance.to_dict()
+# create an instance of UpdateDraft from a dict
+update_draft_from_dict = UpdateDraft.from_dict(update_draft_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/ValidityPeriod.md

@@ -0,0 +1,42 @@
+# ValidityPeriod
+
+Create a new Validity Period on a Published Variable Definition.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**LanguageStringType**](LanguageStringType.md) | Name of the variable. Must be unique for a given Unit Type and Owner combination. | [optional]
+**definition** | [**LanguageStringType**](LanguageStringType.md) | Definition of the variable. |
+**classification_reference** | **str** | ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable. | [optional]
+**unit_types** | **List[str]** | A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702. | [optional]
+**subject_fields** | **List[str]** | A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618. | [optional]
+**contains_special_categories_of_personal_data** | **bool** | True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation | [optional]
+**variable_status** | [**VariableStatus**](VariableStatus.md) | Status of the life cycle of the variable | [optional] [readonly]
+**measurement_type** | **str** | Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303 | [optional]
+**valid_from** | **date** | The variable definition is valid from this date inclusive |
+**external_reference_uri** | **str** | A link (URI) to an external definition/documentation | [optional]
+**comment** | [**LanguageStringType**](LanguageStringType.md) | Optional comment to explain the definition or communicate potential changes. | [optional]
+**related_variable_definition_uris** | **List[str]** | Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc. | [optional]
+**contact** | [**Contact**](Contact.md) | Contact details | [optional]
+
+## Example
+
+```python
+from vardef_client.models.validity_period import ValidityPeriod
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidityPeriod from a JSON string
+validity_period_instance = ValidityPeriod.from_json(json)
+# print the JSON string representation of the object
+print(ValidityPeriod.to_json())
+
+# convert the object into a dict
+validity_period_dict = validity_period_instance.to_dict()
+# create an instance of ValidityPeriod from a dict
+validity_period_from_dict = ValidityPeriod.from_dict(validity_period_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/ValidityPeriodsApi.md

@@ -0,0 +1,236 @@
+# vardef_client.ValidityPeriodsApi
+
+All URIs are relative to *https://metadata.intern.test.ssb.no*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_validity_period**](ValidityPeriodsApi.md#create_validity_period) | **POST** /variable-definitions/{variable-definition-id}/validity-periods | Create a new validity period for a variable definition.
+[**list_public_validity_periods_0**](ValidityPeriodsApi.md#list_public_validity_periods_0) | **GET** /public/variable-definitions/{variable-definition-id}/validity-periods | List all validity periods.
+[**list_validity_periods**](ValidityPeriodsApi.md#list_validity_periods) | **GET** /variable-definitions/{variable-definition-id}/validity-periods | List all validity periods.
+
+
+# **create_validity_period**
+> create_validity_period(variable_definition_id, active_group, validity_period)
+
+Create a new validity period for a variable definition.
+
+Create a new validity period for a variable definition.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.models.validity_period import ValidityPeriod
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.ValidityPeriodsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    active_group = 'dapla-felles-developers' # str | The group which the user currently represents.
+    validity_period = vardef_client.ValidityPeriod() # ValidityPeriod | 
+
+    try:
+        # Create a new validity period for a variable definition.
+        api_instance.create_validity_period(variable_definition_id, active_group, validity_period)
+    except Exception as e:
+        print("Exception when calling ValidityPeriodsApi->create_validity_period: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **active_group** | **str**| The group which the user currently represents. | 
+ **validity_period** | [**ValidityPeriod**](ValidityPeriod.md)|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Successfully created. |  -  |
+**400** | The request is missing or has errors in required fields. |  -  |
+**405** | Method only allowed for published variables. |  -  |
+
+[[Back to top]](#) [[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_public_validity_periods_0**
+> list_public_validity_periods_0(variable_definition_id, accept_language)
+
+List all validity periods.
+
+List all validity periods. These are rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.ValidityPeriodsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+
+    try:
+        # List all validity periods.
+        api_instance.list_public_validity_periods_0(variable_definition_id, accept_language)
+    except Exception as e:
+        print("Exception when calling ValidityPeriodsApi->list_public_validity_periods_0: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+
+[[Back to top]](#) [[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_validity_periods**
+> list_validity_periods(variable_definition_id)
+
+List all validity periods.
+
+List all validity periods.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.ValidityPeriodsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+
+    try:
+        # List all validity periods.
+        api_instance.list_validity_periods(variable_definition_id)
+    except Exception as e:
+        print("Exception when calling ValidityPeriodsApi->list_validity_periods: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+