"""

This module contains every scope used in the application.

The format for defining a scope is:

<SCOPE_SECTION>_<SCOPE_NAME> = "<scope_section>:<scope_name>"

CLIENT_CREATE = "client:create"

`SCOPE_REGISTRY` is intended as a comprehensive list of all available scopes.

"""

from enum import Enum

AUTHORIZE = "authorize"

CLI_OBJECTS = "cli-objects"

CLIENT = "client"

CONFIG = "config"

CONNECTION = "connection"

CONNECTION_TYPE = "connection_type"

CONNECTOR_TEMPLATE = "connector_template"

CONSENT = "consent"

CONSENT_SETTINGS = "consent_settings"

CREATE = "create"

CREATE_OR_UPDATE = "create_or_update"

CTL_DATASET = "ctl_dataset"

CTL_POLICY = "ctl_policy"

CURRENT_PRIVACY_PREFERENCE = "current-privacy-preference"

DATABASE = "database"

DATA_CATEGORY = "data_category"

DATA_SUBJECT = "data_subject"

DATA_USE = "data_use"

DATASET = "dataset"

DELETE = "delete"

ENCRYPTION = "encryption"

MESSAGING_TEMPLATE = "messaging-template"

EVALUATION = "evaluation"

EXEC = "exec"

FIDES_TAXONOMY = "fides_taxonomy"

GENERATE = "generate"

INSTANTIATE = "instantiate"

MASKING = "masking"

MESSAGING = "messaging"

ORGANIZATION = "organization"

PASSWORD_RESET = "password-reset"

POLICY = "policy"

PRIVACY_EXPERIENCE = "privacy-experience"

PRIVACY_NOTICE = "privacy-notice"

PRIVACY_PREFERENCE_HISTORY = "privacy-preference-history"

PRIVACY_REQUEST = "privacy-request"

PRIVACY_REQUEST_NOTIFICATIONS = "privacy-request-notifications"

READ = "read"

REGISTER = "register"

RESET = "reset"

RESUME = "resume"

REVIEW = "review"

RULE = "rule"

SAAS_CONFIG = "saas_config"

SCOPE = "scope"

STORAGE = "storage"

SYSTEM = "system"

SYSTEM_MANAGER = "system_manager"

TAXONOMY = "taxonomy"

TRANSFER = "transfer"

UPDATE = "update"

UPLOAD_DATA = "upload_data"

USER = "user"

USER_PERMISSION = "user-permission"

VALIDATE = "validate"

VIEW_DATA = "view_data"

WEBHOOK = "webhook"

ASSIGN_OWNERS = "assign_owners"

CLIENT_CREATE = f"{CLIENT}:{CREATE}"

CLIENT_DELETE = f"{CLIENT}:{DELETE}"

CLIENT_READ = f"{CLIENT}:{READ}"

CLIENT_UPDATE = f"{CLIENT}:{UPDATE}"

CLI_OBJECTS_CREATE = f"{CLI_OBJECTS}:{CREATE}"

CLI_OBJECTS_READ = f"{CLI_OBJECTS}:{READ}"

CLI_OBJECTS_UPDATE = f"{CLI_OBJECTS}:{UPDATE}"

CLI_OBJECTS_DELETE = f"{CLI_OBJECTS}:{DELETE}"

CONFIG_READ = f"{CONFIG}:{READ}"

CONFIG_UPDATE = f"{CONFIG}:{UPDATE}"

CONNECTION_CREATE_OR_UPDATE = f"{CONNECTION}:{CREATE_OR_UPDATE}"

CONNECTION_DELETE = f"{CONNECTION}:{DELETE}"

CONNECTION_READ = f"{CONNECTION}:{READ}"

CONNECTION_AUTHORIZE = f"{CONNECTION}:{AUTHORIZE}"

CONNECTION_TYPE_READ = f"{CONNECTION_TYPE}:{READ}"

CONSENT_READ = f"{CONSENT}:{READ}"

CONSENT_SETTINGS_READ = f"{CONSENT_SETTINGS}:{READ}"

CONSENT_SETTINGS_UPDATE = f"{CONSENT_SETTINGS}:{UPDATE}"

CTL_DATASET_CREATE = f"{CTL_DATASET}:{CREATE}"

CTL_DATASET_READ = f"{CTL_DATASET}:{READ}"

CTL_DATASET_UPDATE = f"{CTL_DATASET}:{UPDATE}"

CTL_DATASET_DELETE = f"{CTL_DATASET}:{DELETE}"

CTL_POLICY_CREATE = f"{CTL_POLICY}:{CREATE}"

CTL_POLICY_READ = f"{CTL_POLICY}:{READ}"

CTL_POLICY_UPDATE = f"{CTL_POLICY}:{UPDATE}"

CTL_POLICY_DELETE = f"{CTL_POLICY}:{DELETE}"

CURRENT_PRIVACY_PREFERENCE_READ = f"{CURRENT_PRIVACY_PREFERENCE}:{READ}"

DATABASE_RESET = f"{DATABASE}:{RESET}"

DATA_CATEGORY_CREATE = f"{DATA_CATEGORY}:{CREATE}"

DATA_CATEGORY_READ = f"{DATA_CATEGORY}:{READ}"

DATA_CATEGORY_UPDATE = f"{DATA_CATEGORY}:{UPDATE}"

DATA_CATEGORY_DELETE = f"{DATA_CATEGORY}:{DELETE}"

DATA_SUBJECT_CREATE = f"{DATA_SUBJECT}:{CREATE}"

DATA_SUBJECT_READ = f"{DATA_SUBJECT}:{READ}"

DATA_SUBJECT_UPDATE = f"{DATA_SUBJECT}:{UPDATE}"

DATA_SUBJECT_DELETE = f"{DATA_SUBJECT}:{DELETE}"

DATA_USE_CREATE = f"{DATA_USE}:{CREATE}"

DATA_USE_READ = f"{DATA_USE}:{READ}"

DATA_USE_UPDATE = f"{DATA_USE}:{UPDATE}"

DATA_USE_DELETE = f"{DATA_USE}:{DELETE}"

DATASET_CREATE_OR_UPDATE = f"{DATASET}:{CREATE_OR_UPDATE}"

DATASET_DELETE = f"{DATASET}:{DELETE}"

DATASET_READ = f"{DATASET}:{READ}"

ENCRYPTION_EXEC = f"{ENCRYPTION}:{EXEC}"

EVALUATION_CREATE = f"{EVALUATION}:{CREATE}"

EVALUATION_READ = f"{EVALUATION}:{READ}"

EVALUATION_UPDATE = f"{EVALUATION}:{UPDATE}"

EVALUATION_DELETE = f"{EVALUATION}:{DELETE}"

FIDES_TAXONOMY_UPDATE = f"{FIDES_TAXONOMY}:{UPDATE}"

GENERATE_EXEC = f"{GENERATE}:{EXEC}"

MASKING_EXEC = f"{MASKING}:{EXEC}"

MASKING_READ = f"{MASKING}:{READ}"

MESSAGING_CREATE_OR_UPDATE = f"{MESSAGING}:{CREATE_OR_UPDATE}"

MESSAGING_DELETE = f"{MESSAGING}:{DELETE}"

MESSAGING_READ = f"{MESSAGING}:{READ}"

MESSAGING_TEMPLATE_UPDATE = f"{MESSAGING_TEMPLATE}:{UPDATE}"

ORGANIZATION_CREATE = f"{ORGANIZATION}:{CREATE}"

ORGANIZATION_READ = f"{ORGANIZATION}:{READ}"

ORGANIZATION_UPDATE = f"{ORGANIZATION}:{UPDATE}"

ORGANIZATION_DELETE = f"{ORGANIZATION}:{DELETE}"

POLICY_CREATE_OR_UPDATE = f"{POLICY}:{CREATE_OR_UPDATE}"

POLICY_DELETE = f"{POLICY}:{DELETE}"

POLICY_READ = f"{POLICY}:{READ}"

PRIVACY_EXPERIENCE_CREATE = f"{PRIVACY_EXPERIENCE}:{CREATE}"

PRIVACY_EXPERIENCE_UPDATE = f"{PRIVACY_EXPERIENCE}:{UPDATE}"

PRIVACY_EXPERIENCE_READ = f"{PRIVACY_EXPERIENCE}:{READ}"

PRIVACY_NOTICE_CREATE = f"{PRIVACY_NOTICE}:{CREATE}"

PRIVACY_NOTICE_UPDATE = f"{PRIVACY_NOTICE}:{UPDATE}"

PRIVACY_NOTICE_READ = f"{PRIVACY_NOTICE}:{READ}"

PRIVACY_PREFERENCE_HISTORY_READ = f"{PRIVACY_PREFERENCE_HISTORY}:{READ}"

PRIVACY_REQUEST_CALLBACK_RESUME = f"{PRIVACY_REQUEST}:{RESUME}" # User has permission to restart a paused privacy request

PRIVACY_REQUEST_CREATE = f"{PRIVACY_REQUEST}:{CREATE}"

PRIVACY_REQUEST_DELETE = f"{PRIVACY_REQUEST}:{DELETE}"

PRIVACY_REQUEST_NOTIFICATIONS_CREATE_OR_UPDATE = (

f"{PRIVACY_REQUEST_NOTIFICATIONS}:{CREATE_OR_UPDATE}"

)

PRIVACY_REQUEST_NOTIFICATIONS_READ = f"{PRIVACY_REQUEST_NOTIFICATIONS}:{READ}"

PRIVACY_REQUEST_READ = f"{PRIVACY_REQUEST}:{READ}"

PRIVACY_REQUEST_REVIEW = f"{PRIVACY_REQUEST}:{REVIEW}"

PRIVACY_REQUEST_TRANSFER = f"{PRIVACY_REQUEST}:{TRANSFER}"

PRIVACY_REQUEST_UPLOAD_DATA = f"{PRIVACY_REQUEST}:{UPLOAD_DATA}"

PRIVACY_REQUEST_VIEW_DATA = f"{PRIVACY_REQUEST}:{VIEW_DATA}"

RULE_CREATE_OR_UPDATE = f"{RULE}:{CREATE_OR_UPDATE}"

RULE_DELETE = f"{RULE}:{DELETE}"

RULE_READ = f"{RULE}:{READ}"

SAAS_CONFIG_CREATE_OR_UPDATE = f"{SAAS_CONFIG}:{CREATE_OR_UPDATE}"

SAAS_CONFIG_DELETE = f"{SAAS_CONFIG}:{DELETE}"

SAAS_CONFIG_READ = f"{SAAS_CONFIG}:{READ}"

SAAS_CONNECTION_INSTANTIATE = f"{CONNECTION}:{INSTANTIATE}"

CONNECTOR_TEMPLATE_REGISTER = f"{CONNECTOR_TEMPLATE}:{REGISTER}"

SCOPE_READ = f"{SCOPE}:{READ}"

STORAGE_CREATE_OR_UPDATE = f"{STORAGE}:{CREATE_OR_UPDATE}"

STORAGE_DELETE = f"{STORAGE}:{DELETE}"

STORAGE_READ = f"{STORAGE}:{READ}"

SYSTEM_CREATE = f"{SYSTEM}:{CREATE}"

SYSTEM_READ = f"{SYSTEM}:{READ}"

SYSTEM_UPDATE = f"{SYSTEM}:{UPDATE}"

SYSTEM_DELETE = f"{SYSTEM}:{DELETE}"

SYSTEM_MANAGER_READ = f"{SYSTEM_MANAGER}:{READ}"

SYSTEM_MANAGER_UPDATE = f"{SYSTEM_MANAGER}:{UPDATE}"

SYSTEM_MANAGER_DELETE = f"{SYSTEM_MANAGER}:{DELETE}"

TAXONOMY_CREATE = f"{TAXONOMY}:{CREATE}"

TAXONOMY_UPDATE = f"{TAXONOMY}:{UPDATE}"

TAXONOMY_DELETE = f"{TAXONOMY}:{DELETE}"

USER_CREATE = f"{USER}:{CREATE}"

USER_DELETE = f"{USER}:{DELETE}"

USER_READ = f"{USER}:{READ}"

USER_UPDATE = f"{USER}:{UPDATE}"

USER_PASSWORD_RESET = f"{USER}:{PASSWORD_RESET}"

USER_PERMISSION_CREATE = f"{USER_PERMISSION}:{CREATE}"

USER_PERMISSION_UPDATE = f"{USER_PERMISSION}:{UPDATE}"

USER_PERMISSION_READ = f"{USER_PERMISSION}:{READ}"

USER_PERMISSION_ASSIGN_OWNERS = f"{USER_PERMISSION}:{ASSIGN_OWNERS}"

VALIDATE_EXEC = f"{VALIDATE}:{EXEC}"

WEBHOOK_CREATE_OR_UPDATE = f"{WEBHOOK}:{CREATE_OR_UPDATE}"

WEBHOOK_DELETE = f"{WEBHOOK}:{DELETE}"

WEBHOOK_READ = f"{WEBHOOK}:{READ}"

SCOPE_DOCS = {

}

SCOPE_REGISTRY = list(SCOPE_DOCS.keys())

# mypy doesn't like taking the dictionary to generate the enum

# https://github.com/python/mypy/issues/5317

ScopeRegistryEnum = Enum( # type: ignore[misc]

"ScopeRegistryEnum", {scope: scope for scope in SCOPE_REGISTRY} # type: ignore

)