symbols:
# region models
'DtoExtendConfigDTO@py.gdpr.mod':
id: 'DtoExtendConfigDTO@py.gdpr.mod'
name: 'DtoExtendConfigDTO'
type: 'model'
fields:
'app_name':
type: 'str'
required: true
description: |-
extend app name
'namespace':
type: 'str'
required: true
description: |-
extend app namespace
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_extend_config_dto.py'
example: |-
dto_extend_config_dto = gdpr_models.DtoExtendConfigDTO.create(...)
'DtoFinishedDataDeletion@py.gdpr.mod':
id: 'DtoFinishedDataDeletion@py.gdpr.mod'
name: 'DtoFinishedDataDeletion'
type: 'model'
fields:
'finished_date':
type: 'str'
required: true
description: |-
Finished deletion date
'request_date':
type: 'str'
required: true
description: |-
Request deletion date
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
Status of request
'user_id':
type: 'str'
required: true
description: |-
User Id. This userId will be anonymized automatically after 7 days from the **Success** deletion
'failed_message':
type: 'str'
required: false
description: |-
Failed message if status is Failed
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_finished_data_deletion.py'
example: |-
dto_finished_data_deletion = gdpr_models.DtoFinishedDataDeletion.create(...)
'DtoFinishedDataRequest@py.gdpr.mod':
id: 'DtoFinishedDataRequest@py.gdpr.mod'
name: 'DtoFinishedDataRequest'
type: 'model'
fields:
'finished_date':
type: 'str'
required: true
description: |-
Finished date
'request_date':
type: 'str'
required: true
description: |-
Request date
'request_id':
type: 'str'
required: true
description: |-
Request id
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
Status of request
'user_id':
type: 'str'
required: true
'data_expiration_date':
type: 'str'
required: false
description: |-
The expiration date of generated data, it was 28 days after finishedDate. Available only if the status is Completed
'failed_message':
type: 'str'
required: false
description: |-
Failed message if status is Failed
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_finished_data_request.py'
example: |-
dto_finished_data_request = gdpr_models.DtoFinishedDataRequest.create(...)
'DtoListFinishedDataDeletion@py.gdpr.mod':
id: 'DtoListFinishedDataDeletion@py.gdpr.mod'
name: 'DtoListFinishedDataDeletion'
type: 'model'
fields:
'data':
type: 'List[DtoFinishedDataDeletion]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_list_finished_data_deletion.py'
example: |-
dto_list_finished_data_deletion = gdpr_models.DtoListFinishedDataDeletion.create(...)
'DtoListFinishedDataRequests@py.gdpr.mod':
id: 'DtoListFinishedDataRequests@py.gdpr.mod'
name: 'DtoListFinishedDataRequests'
type: 'model'
fields:
'data':
type: 'List[DtoFinishedDataRequest]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_list_finished_data_requests.py'
example: |-
dto_list_finished_data_requests = gdpr_models.DtoListFinishedDataRequests.create(...)
'DtoPlatformAccountClosureClientRequest@py.gdpr.mod':
id: 'DtoPlatformAccountClosureClientRequest@py.gdpr.mod'
name: 'DtoPlatformAccountClosureClientRequest'
type: 'model'
fields:
'bp_cert':
type: 'str'
required: false
description: |-
required for xbox
'bp_cert_file_name':
type: 'str'
required: false
description: |-
required for xbox
'client_id':
type: 'str'
required: false
description: |-
required for psn
'password':
type: 'str'
required: false
description: |-
required for xbox
'publisher_key':
type: 'str'
required: false
description: |-
required for steam
'sandbox_id':
type: 'str'
required: false
description: |-
required for xbox
'secret':
type: 'str'
required: false
description: |-
required for psn
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_platform_account_closure_client_request.py'
example: |-
dto_platform_account_closure_client_request = gdpr_models.DtoPlatformAccountClosureClientRequest.create(...)
'DtoPlatformAccountClosureClientResponse@py.gdpr.mod':
id: 'DtoPlatformAccountClosureClientResponse@py.gdpr.mod'
name: 'DtoPlatformAccountClosureClientResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'platform':
type: 'str'
required: true
'updated_at':
type: 'int'
required: true
'bp_cert_expire_at':
type: 'int'
required: false
'bp_cert_file_name':
type: 'str'
required: false
'client_id':
type: 'str'
required: false
'publisher_key':
type: 'str'
required: false
'sandbox_id':
type: 'str'
required: false
'secret':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_platform_account_closure_client_response.py'
example: |-
dto_platform_account_closure_client_response = gdpr_models.DtoPlatformAccountClosureClientResponse.create(...)
'DtoPlatformAccountClosureClientsResponse@py.gdpr.mod':
id: 'DtoPlatformAccountClosureClientsResponse@py.gdpr.mod'
name: 'DtoPlatformAccountClosureClientsResponse'
type: 'model'
fields:
'data':
type: 'List[DtoPlatformAccountClosureClientResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_platform_account_closure_clients_response.py'
example: |-
dto_platform_account_closure_clients_response = gdpr_models.DtoPlatformAccountClosureClientsResponse.create(...)
'DtoPlatformAccountClosureMockRequest@py.gdpr.mod':
id: 'DtoPlatformAccountClosureMockRequest@py.gdpr.mod'
name: 'DtoPlatformAccountClosureMockRequest'
type: 'model'
fields:
'platform_user_id':
type: 'str'
required: true
'sandbox':
type: 'str'
required: true
'start_immediately':
type: 'bool'
required: true
description: |-
start the account closure process immediately
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_platform_account_closure_mock_request.py'
example: |-
dto_platform_account_closure_mock_request = gdpr_models.DtoPlatformAccountClosureMockRequest.create(...)
'DtoS2SDataRequestSummary@py.gdpr.mod':
id: 'DtoS2SDataRequestSummary@py.gdpr.mod'
name: 'DtoS2SDataRequestSummary'
type: 'model'
fields:
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
Status of the request
'failed_message':
type: 'str'
required: false
description: |-
Failed message if status is Failed
'url':
type: 'str'
required: false
description: |-
Download url if status is Completed
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_s2s_data_request_summary.py'
example: |-
dto_s2s_data_request_summary = gdpr_models.DtoS2SDataRequestSummary.create(...)
'DtoServiceConfigDTO@py.gdpr.mod':
id: 'DtoServiceConfigDTO@py.gdpr.mod'
name: 'DtoServiceConfigDTO'
type: 'model'
fields:
'protocol':
type: 'Union[str, ProtocolEnum]'
required: true
description: |-
protocol type
'skip_ack':
type: 'bool'
required: false
description: |-
skip waiting for ack event from this service, used in "EVENT" protocol only.
'url':
type: 'str'
required: false
description: |-
url of the service with port number, required in "GRPC" protocol
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_service_config_dto.py'
example: |-
dto_service_config_dto = gdpr_models.DtoServiceConfigDTO.create(...)
'DtoServiceConfigurationDTO@py.gdpr.mod':
id: 'DtoServiceConfigurationDTO@py.gdpr.mod'
name: 'DtoServiceConfigurationDTO'
type: 'model'
fields:
'id_':
type: 'str'
required: true
description: |-
service id
'type_':
type: 'Union[str, TypeEnum]'
required: true
description: |-
service type
'extend_config':
type: 'DtoExtendConfigDTO'
required: false
description: |-
extend configuration detail, required when "type" is "EXTEND"
'service_config':
type: 'DtoServiceConfigDTO'
required: false
description: |-
service configuration detail, required when "type" is "SERVICE"
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_service_configuration_dto.py'
example: |-
dto_service_configuration_dto = gdpr_models.DtoServiceConfigurationDTO.create(...)
'DtoServiceConfigurationUpdateRequest@py.gdpr.mod':
id: 'DtoServiceConfigurationUpdateRequest@py.gdpr.mod'
name: 'DtoServiceConfigurationUpdateRequest'
type: 'model'
fields:
'services':
type: 'List[DtoServiceConfigurationDTO]'
required: true
description: |-
list of services
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_service_configuration_update_request.py'
example: |-
dto_service_configuration_update_request = gdpr_models.DtoServiceConfigurationUpdateRequest.create(...)
'DtoServicesConfigurationResponse@py.gdpr.mod':
id: 'DtoServicesConfigurationResponse@py.gdpr.mod'
name: 'DtoServicesConfigurationResponse'
type: 'model'
fields:
'services':
type: 'List[DtoServiceConfigurationDTO]'
required: true
description: |-
list of services
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_services_configuration_response.py'
example: |-
dto_services_configuration_response = gdpr_models.DtoServicesConfigurationResponse.create(...)
'DtoUserPlatformAccountClosureHistoriesResponse@py.gdpr.mod':
id: 'DtoUserPlatformAccountClosureHistoriesResponse@py.gdpr.mod'
name: 'DtoUserPlatformAccountClosureHistoriesResponse'
type: 'model'
fields:
'data':
type: 'List[DtoUserPlatformAccountClosureHistory]'
required: true
'pagination':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_user_platform_account_closure_histories_response.py'
example: |-
dto_user_platform_account_closure_histories_response = gdpr_models.DtoUserPlatformAccountClosureHistoriesResponse.create(...)
'DtoUserPlatformAccountClosureHistory@py.gdpr.mod':
id: 'DtoUserPlatformAccountClosureHistory@py.gdpr.mod'
name: 'DtoUserPlatformAccountClosureHistory'
type: 'model'
fields:
'closed_date':
type: 'int'
required: true
'environment':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'platform':
type: 'str'
required: true
'platform_user_id':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_user_platform_account_closure_history.py'
example: |-
dto_user_platform_account_closure_history = gdpr_models.DtoUserPlatformAccountClosureHistory.create(...)
'DtoXboxBPCertValidationRequest@py.gdpr.mod':
id: 'DtoXboxBPCertValidationRequest@py.gdpr.mod'
name: 'DtoXboxBPCertValidationRequest'
type: 'model'
fields:
'bp_cert':
type: 'str'
required: true
'password':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_xbox_bp_cert_validation_request.py'
example: |-
dto_xbox_bp_cert_validation_request = gdpr_models.DtoXboxBPCertValidationRequest.create(...)
'DtoXboxBPCertValidationResponse@py.gdpr.mod':
id: 'DtoXboxBPCertValidationResponse@py.gdpr.mod'
name: 'DtoXboxBPCertValidationResponse'
type: 'model'
fields:
'expiration_date':
type: 'int'
required: true
'expired':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/dto_xbox_bp_cert_validation_response.py'
example: |-
dto_xbox_bp_cert_validation_response = gdpr_models.DtoXboxBPCertValidationResponse.create(...)
'ModelsDataRetrievalResponse@py.gdpr.mod':
id: 'ModelsDataRetrievalResponse@py.gdpr.mod'
name: 'ModelsDataRetrievalResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'request_date':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_data_retrieval_response.py'
example: |-
models_data_retrieval_response = gdpr_models.ModelsDataRetrievalResponse.create(...)
'ModelsDeletionData@py.gdpr.mod':
id: 'ModelsDeletionData@py.gdpr.mod'
name: 'ModelsDeletionData'
type: 'model'
fields:
'display_name':
type: 'str'
required: true
'request_date':
type: 'str'
required: true
'status':
type: 'str'
required: true
'unique_display_name':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_deletion_data.py'
example: |-
models_deletion_data = gdpr_models.ModelsDeletionData.create(...)
'ModelsDeletionStatus@py.gdpr.mod':
id: 'ModelsDeletionStatus@py.gdpr.mod'
name: 'ModelsDeletionStatus'
type: 'model'
fields:
'deletion_date':
type: 'str'
required: true
'deletion_status':
type: 'bool'
required: true
'display_name':
type: 'str'
required: true
'status':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'execution_date':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_deletion_status.py'
example: |-
models_deletion_status = gdpr_models.ModelsDeletionStatus.create(...)
'ModelsListDeletionDataResponse@py.gdpr.mod':
id: 'ModelsListDeletionDataResponse@py.gdpr.mod'
name: 'ModelsListDeletionDataResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsDeletionData]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_list_deletion_data_response.py'
example: |-
models_list_deletion_data_response = gdpr_models.ModelsListDeletionDataResponse.create(...)
'ModelsListPersonalDataResponse@py.gdpr.mod':
id: 'ModelsListPersonalDataResponse@py.gdpr.mod'
name: 'ModelsListPersonalDataResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsPersonalData]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_list_personal_data_response.py'
example: |-
models_list_personal_data_response = gdpr_models.ModelsListPersonalDataResponse.create(...)
'ModelsPagination@py.gdpr.mod':
id: 'ModelsPagination@py.gdpr.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_pagination.py'
example: |-
models_pagination = gdpr_models.ModelsPagination.create(...)
'ModelsPersonalData@py.gdpr.mod':
id: 'ModelsPersonalData@py.gdpr.mod'
name: 'ModelsPersonalData'
type: 'model'
fields:
'data_expiration_date':
type: 'str'
required: true
'display_name':
type: 'str'
required: true
'request_date':
type: 'str'
required: true
'service_errors':
type: 'Dict[str, str]'
required: true
'service_statuses':
type: 'Dict[str, str]'
required: true
'status':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_personal_data.py'
example: |-
models_personal_data = gdpr_models.ModelsPersonalData.create(...)
'ModelsRequestDeleteResponse@py.gdpr.mod':
id: 'ModelsRequestDeleteResponse@py.gdpr.mod'
name: 'ModelsRequestDeleteResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_request_delete_response.py'
example: |-
models_request_delete_response = gdpr_models.ModelsRequestDeleteResponse.create(...)
'ModelsS2SDataRetrievalResponse@py.gdpr.mod':
id: 'ModelsS2SDataRetrievalResponse@py.gdpr.mod'
name: 'ModelsS2SDataRetrievalResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'request_date':
type: 'str'
required: true
'request_id':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_s2s_data_retrieval_response.py'
example: |-
models_s2s_data_retrieval_response = gdpr_models.ModelsS2SDataRetrievalResponse.create(...)
'ModelsS2SRequestDeleteResponse@py.gdpr.mod':
id: 'ModelsS2SRequestDeleteResponse@py.gdpr.mod'
name: 'ModelsS2SRequestDeleteResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_s2s_request_delete_response.py'
example: |-
models_s2s_request_delete_response = gdpr_models.ModelsS2SRequestDeleteResponse.create(...)
'ModelsS2SUserDataURL@py.gdpr.mod':
id: 'ModelsS2SUserDataURL@py.gdpr.mod'
name: 'ModelsS2SUserDataURL'
type: 'model'
fields:
'url':
type: 'str'
required: true
description: |-
Download url if status is Completed
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_s2s_user_data_url.py'
example: |-
models_s2s_user_data_url = gdpr_models.ModelsS2SUserDataURL.create(...)
'ModelsUserDataURL@py.gdpr.mod':
id: 'ModelsUserDataURL@py.gdpr.mod'
name: 'ModelsUserDataURL'
type: 'model'
fields:
'url':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_user_data_url.py'
example: |-
models_user_data_url = gdpr_models.ModelsUserDataURL.create(...)
'ModelsUserPersonalData@py.gdpr.mod':
id: 'ModelsUserPersonalData@py.gdpr.mod'
name: 'ModelsUserPersonalData'
type: 'model'
fields:
'data_expiration_date':
type: 'str'
required: true
'request_date':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_user_personal_data.py'
example: |-
models_user_personal_data = gdpr_models.ModelsUserPersonalData.create(...)
'ModelsUserPersonalDataResponse@py.gdpr.mod':
id: 'ModelsUserPersonalDataResponse@py.gdpr.mod'
name: 'ModelsUserPersonalDataResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsUserPersonalData]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/models_user_personal_data_response.py'
example: |-
models_user_personal_data_response = gdpr_models.ModelsUserPersonalDataResponse.create(...)
'ResponseError@py.gdpr.mod':
id: 'ResponseError@py.gdpr.mod'
name: 'ResponseError'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
'message_variables':
type: 'Dict[str, str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/models/response_error.py'
example: |-
response_error = gdpr_models.ResponseError.create(...)
# endregion models
# region functions
'admin_cancel_user_account_deletion_request@py.gdpr.fun':
id: 'admin_cancel_user_account_deletion_request@py.gdpr.fun'
name: 'admin_cancel_user_account_deletion_request'
type: 'function'
description: |-
Cancel user's account deletion request
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/admin_cancel_user_accou_de1ba5.py'
example: |-
result, error = gdpr.admin_cancel_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'cancel'
- 'data'
- 'deletion'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'admin_cancel_user_personal_data_request@py.gdpr.fun':
id: 'admin_cancel_user_personal_data_request@py.gdpr.fun'
name: 'admin_cancel_user_personal_data_request'
type: 'function'
description: |-
Cancel user's personal data requests
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'request_date':
type: 'str'
required: true
description: |-
Request date in RFC3339 format
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/admin_cancel_user_perso_78952d.py'
example: |-
result, error = gdpr.admin_cancel_user_personal_data_request(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'cancel'
- 'data'
- 'personal'
- 'request'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'admin_delete_platform_account_closure_client@py.gdpr.fun':
id: 'admin_delete_platform_account_closure_client@py.gdpr.fun'
name: 'admin_delete_platform_account_closure_client'
type: 'function'
description: |-
Delete platform account closure client.
The namespace should be **publisher or studio namespace**
-------
Platform:
- steamnetwork
- xbox
- psn
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'platform':
type: 'str'
required: true
description: |-
3rd party platform
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_delete_platform_a_6b01ab.py'
example: |-
result, error = gdpr.admin_delete_platform_account_closure_client(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'delete'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'admin_generate_personal_data_url@py.gdpr.fun':
id: 'admin_generate_personal_data_url@py.gdpr.fun'
name: 'admin_generate_personal_data_url'
type: 'function'
description: |-
Required permission `ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]` and scope `account`
If admin request data for themselves, password is need to be set
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'password':
type: 'Optional[str]'
required: false
description: |-
If admin request data for themselves, then password is required
'request_date':
type: 'str'
required: true
description: |-
Request date in RFC3339 format
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[Union[None, ModelsUserDataURL], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/admin_generate_personal_48c32b.py'
example: |-
result, error = gdpr.admin_generate_personal_data_url(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'admin_get_list_deletion_data_request@py.gdpr.fun':
id: 'admin_get_list_deletion_data_request@py.gdpr.fun'
name: 'admin_get_list_deletion_data_request'
type: 'function'
description: |-
Retrieve all user's account deletion requests in specified date
Scope: account
arguments:
'after':
type: 'Optional[str]'
required: false
description: |-
The day in UTC format to get deletion request list after that. format : YYYY-MM-DD
'before':
type: 'Optional[str]'
required: false
description: |-
The day in UTC format to get deletion request list before that. format : YYYY-MM-DD
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'request_date':
type: 'Optional[str]'
required: false
description: |-
The day in UTC of the deletion request. format : YYYY-MM-DD. Default : today time in UTC.
return_type: 'Tuple[Union[None, ModelsListDeletionDataResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/admin_get_list_deletion_227d7d.py'
example: |-
result, error = gdpr.admin_get_list_deletion_data_request(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'list'
- 'request'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'admin_get_list_personal_data_request@py.gdpr.fun':
id: 'admin_get_list_personal_data_request@py.gdpr.fun'
name: 'admin_get_list_personal_data_request'
type: 'function'
description: |-
Get list personal data requests
Scope: account
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'request_date':
type: 'Optional[str]'
required: false
description: |-
request date with format YYYY-MM-DD. Default value today UTC
return_type: 'Tuple[Union[None, ModelsListPersonalDataResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/admin_get_list_personal_424fda.py'
example: |-
result, error = gdpr.admin_get_list_personal_data_request(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'admin_get_platform_account_closure_client@py.gdpr.fun':
id: 'admin_get_platform_account_closure_client@py.gdpr.fun'
name: 'admin_get_platform_account_closure_client'
type: 'function'
description: |-
Get platform account closure config.
The namespace should be **publisher or studio namespace**
----------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'platform':
type: 'str'
required: true
description: |-
3rd party platform
return_type: 'Tuple[Union[None, DtoPlatformAccountClosureClientResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_get_platform_acco_4a3f07.py'
example: |-
result, error = gdpr.admin_get_platform_account_closure_client(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'admin_get_platform_account_closure_clients@py.gdpr.fun':
id: 'admin_get_platform_account_closure_clients@py.gdpr.fun'
name: 'admin_get_platform_account_closure_clients'
type: 'function'
description: |-
Get platform account closure configs.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoPlatformAccountClosureClientsResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_get_platform_acco_f2bbf3.py'
example: |-
result, error = gdpr.admin_get_platform_account_closure_clients(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'client'
- 'clients'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'admin_get_platform_account_closure_services_configuration@py.gdpr.fun':
id: 'admin_get_platform_account_closure_services_configuration@py.gdpr.fun'
name: 'admin_get_platform_account_closure_services_configuration'
type: 'function'
description: |-
Get registered platform account closure services configuration.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoServicesConfigurationResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_get_platform_acco_c23147.py'
example: |-
result, error = gdpr.admin_get_platform_account_closure_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'get'
- 'platform'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'admin_get_services_configuration@py.gdpr.fun':
id: 'admin_get_services_configuration@py.gdpr.fun'
name: 'admin_get_services_configuration'
type: 'function'
description: |-
Get Registered Services Configuration.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoServicesConfigurationResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_get_services_conf_be46ef.py'
example: |-
result, error = gdpr.admin_get_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'get'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'admin_get_user_account_deletion_request@py.gdpr.fun':
id: 'admin_get_user_account_deletion_request@py.gdpr.fun'
name: 'admin_get_user_account_deletion_request'
type: 'function'
description: |-
Retrieve specific user's account deletion request
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[Union[None, ModelsDeletionData], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/admin_get_user_account__84ef5a.py'
example: |-
result, error = gdpr.admin_get_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'admin_get_user_personal_data_requests@py.gdpr.fun':
id: 'admin_get_user_personal_data_requests@py.gdpr.fun'
name: 'admin_get_user_personal_data_requests'
type: 'function'
description: |-
Get user's personal data requests
Scope: account
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[Union[None, ModelsUserPersonalDataResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/admin_get_user_personal_a892c0.py'
example: |-
result, error = gdpr.admin_get_user_personal_data_requests(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'personal'
- 'requests'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'admin_get_user_platform_account_closure_histories@py.gdpr.fun':
id: 'admin_get_user_platform_account_closure_histories@py.gdpr.fun'
name: 'admin_get_user_platform_account_closure_histories'
type: 'function'
description: |-
Get user's platform account closure histories.
Scope: account
------
Supported platforms:
- psn
- steamnetwork
- xbox
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
limit
'namespace':
type: 'str'
required: true
description: |-
namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'platform':
type: 'Optional[str]'
required: false
description: |-
3rd party platform
'user_id':
type: 'Optional[str]'
required: false
description: |-
IAM ID of the user
return_type: 'Tuple[Union[None, DtoUserPlatformAccountClosureHistoriesResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_history/admin_get_user_platform_8a8aa4.py'
example: |-
result, error = gdpr.admin_get_user_platform_account_closure_histories(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'closure'
- 'get'
- 'histories'
- 'history'
- 'platform'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER [READ]'
'admin_mock_platform_account_closure_data@py.gdpr.fun':
id: 'admin_mock_platform_account_closure_data@py.gdpr.fun'
name: 'admin_mock_platform_account_closure_data'
type: 'function'
description: |-
Mock platform account closure data.
-----
**This is only for testing**
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'body':
type: 'DtoPlatformAccountClosureMockRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
'platform':
type: 'str'
required: true
description: |-
3rd party platform
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_mock_platform_acc_903642.py'
example: |-
result, error = gdpr.admin_mock_platform_account_closure_data(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'data'
- 'mock'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'admin_request_data_retrieval@py.gdpr.fun':
id: 'admin_request_data_retrieval@py.gdpr.fun'
name: 'admin_request_data_retrieval'
type: 'function'
description: |-
Submit user personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'password':
type: 'Optional[str]'
required: false
description: |-
IAM password of the user, required if admin requests their own data
'user_id':
type: 'str'
required: true
description: |-
IAM user ID
return_type: 'Tuple[Union[None, ModelsDataRetrievalResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/admin_request_data_retrieval.py'
example: |-
result, error = gdpr.admin_request_data_retrieval(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'admin_reset_platform_account_closure_services_configuration@py.gdpr.fun':
id: 'admin_reset_platform_account_closure_services_configuration@py.gdpr.fun'
name: 'admin_reset_platform_account_closure_services_configuration'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset registered platform account closure services configuration to use the default configuration.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_reset_platform_ac_c4b31b.py'
example: |-
result, error = gdpr.admin_reset_platform_account_closure_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'admin_reset_services_configuration@py.gdpr.fun':
id: 'admin_reset_services_configuration@py.gdpr.fun'
name: 'admin_reset_services_configuration'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset Registered Services Configuration to use the default configuration.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_reset_services_co_abf06c.py'
example: |-
result, error = gdpr.admin_reset_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'admin_submit_user_account_deletion_request@py.gdpr.fun':
id: 'admin_submit_user_account_deletion_request@py.gdpr.fun'
name: 'admin_submit_user_account_deletion_request'
type: 'function'
description: |-
Submit user's account deletion request.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[Union[None, ModelsRequestDeleteResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/admin_submit_user_accou_b7780f.py'
example: |-
result, error = gdpr.admin_submit_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'request'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'admin_update_platform_account_closure_client@py.gdpr.fun':
id: 'admin_update_platform_account_closure_client@py.gdpr.fun'
name: 'admin_update_platform_account_closure_client'
type: 'function'
description: |-
Update platform account closure client.
The namespace should be the **publisher or studio namespace**.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'body':
type: 'DtoPlatformAccountClosureClientRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
'platform':
type: 'str'
required: true
description: |-
3rd party platform
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_update_platform_a_818a23.py'
example: |-
result, error = gdpr.admin_update_platform_account_closure_client(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'platform'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'admin_update_platform_account_closure_services_configuration@py.gdpr.fun':
id: 'admin_update_platform_account_closure_services_configuration@py.gdpr.fun'
name: 'admin_update_platform_account_closure_services_configuration'
type: 'function'
description: |-
Update registered platform account closure services configuration.
Scope: account
arguments:
'body':
type: 'DtoServiceConfigurationUpdateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoServiceConfigurationUpdateRequest], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_update_platform_a_1f24aa.py'
example: |-
result, error = gdpr.admin_update_platform_account_closure_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'admin_update_services_configuration@py.gdpr.fun':
id: 'admin_update_services_configuration@py.gdpr.fun'
name: 'admin_update_services_configuration'
type: 'function'
description: |-
Update Registered Services Configuration.
Scope: account
arguments:
'body':
type: 'DtoServiceConfigurationUpdateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoServiceConfigurationUpdateRequest], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/admin_update_services_c_ea010e.py'
example: |-
result, error = gdpr.admin_update_services_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'admin_validate_xbox_bp_cert_file@py.gdpr.fun':
id: 'admin_validate_xbox_bp_cert_file@py.gdpr.fun'
name: 'admin_validate_xbox_bp_cert_file'
type: 'function'
description: |-
Check xbox BP cert file whether it's expired and return expiration date
arguments:
'body':
type: 'DtoXboxBPCertValidationRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, DtoXboxBPCertValidationResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/platform_account_closure_client/admin_validate_xbox_bp__812c1c.py'
example: |-
result, error = gdpr.admin_validate_xbox_bp_cert_file(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'admin'
- 'bp'
- 'cert'
- 'client'
- 'closure'
- 'file'
- 'platform'
- 'validate'
- 'xbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'delete_admin_email_configuration@py.gdpr.fun':
id: 'delete_admin_email_configuration@py.gdpr.fun'
name: 'delete_admin_email_configuration'
type: 'function'
description: |-
Delete a list of admin email addresses to stop receiving personal data request notification.
Scope: account
arguments:
'emails':
type: 'List[str]'
required: true
description: |-
list of admin email to delete
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/delete_admin_email_conf_009cca.py'
example: |-
result, error = gdpr.delete_admin_email_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'email'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [DELETE]'
'get_admin_email_configuration@py.gdpr.fun':
id: 'get_admin_email_configuration@py.gdpr.fun'
name: 'get_admin_email_configuration'
type: 'function'
description: |-
Get list of admin email address configuration.
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, List[str]], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/get_admin_email_configuration.py'
example: |-
result, error = gdpr.get_admin_email_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'email'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [READ]'
'public_cancel_my_account_deletion_request@py.gdpr.fun':
id: 'public_cancel_my_account_deletion_request@py.gdpr.fun'
name: 'public_cancel_my_account_deletion_request'
type: 'function'
description: |-
Cancel my account deletion request
Requires valid user access token
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_cancel_my_accoun_107811.py'
example: |-
result, error = gdpr.public_cancel_my_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
'public_cancel_user_account_deletion_request@py.gdpr.fun':
id: 'public_cancel_user_account_deletion_request@py.gdpr.fun'
name: 'public_cancel_user_account_deletion_request'
type: 'function'
description: |-
Cancel user's account deletion request
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_cancel_user_acco_16b962.py'
example: |-
result, error = gdpr.public_cancel_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'user'
'public_cancel_user_personal_data_request@py.gdpr.fun':
id: 'public_cancel_user_personal_data_request@py.gdpr.fun'
name: 'public_cancel_user_personal_data_request'
type: 'function'
description: |-
Cancel user's personal data requests
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'request_date':
type: 'str'
required: true
description: |-
Request date in RFC3339 format
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/public_cancel_user_pers_19dafa.py'
example: |-
result, error = gdpr.public_cancel_user_personal_data_request(...)
if error:
# handle_error(error)
tags:
- 'cancel'
- 'data'
- 'personal'
- 'public'
- 'request'
- 'retrieval'
- 'user'
'public_generate_personal_data_url@py.gdpr.fun':
id: 'public_generate_personal_data_url@py.gdpr.fun'
name: 'public_generate_personal_data_url'
type: 'function'
description: |-
Generate personal data download url
Requires valid user access token
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'password':
type: 'str'
required: true
description: |-
IAM password of the user
'request_date':
type: 'str'
required: true
description: |-
Request date in RFC3339 format
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[Union[None, ModelsUserDataURL], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/public_generate_persona_6b68a4.py'
example: |-
result, error = gdpr.public_generate_personal_data_url(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'generate'
- 'personal'
- 'public'
- 'retrieval'
- 'url'
'public_get_my_account_deletion_status@py.gdpr.fun':
id: 'public_get_my_account_deletion_status@py.gdpr.fun'
name: 'public_get_my_account_deletion_status'
type: 'function'
description: |-
Retrieve my account deletion status
Requires valid user access token
return_type: 'Tuple[Union[None, ModelsDeletionStatus], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_get_my_account_d_8595d0.py'
example: |-
result, error = gdpr.public_get_my_account_deletion_status(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'my'
- 'public'
- 'status'
'public_get_user_account_deletion_status@py.gdpr.fun':
id: 'public_get_user_account_deletion_status@py.gdpr.fun'
name: 'public_get_user_account_deletion_status'
type: 'function'
description: |-
Retrieve specific user's account deletion status
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[Union[None, ModelsDeletionStatus], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_get_user_account_09e4f2.py'
example: |-
result, error = gdpr.public_get_user_account_deletion_status(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'public'
- 'status'
- 'user'
'public_get_user_personal_data_requests@py.gdpr.fun':
id: 'public_get_user_personal_data_requests@py.gdpr.fun'
name: 'public_get_user_personal_data_requests'
type: 'function'
description: |-
Get user's personal data requests
Requires valid user access token
Scope: account
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[Union[None, ModelsUserPersonalDataResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/public_get_user_persona_7e40c3.py'
example: |-
result, error = gdpr.public_get_user_personal_data_requests(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'get'
- 'personal'
- 'public'
- 'requests'
- 'retrieval'
- 'user'
'public_request_data_retrieval@py.gdpr.fun':
id: 'public_request_data_retrieval@py.gdpr.fun'
name: 'public_request_data_retrieval'
type: 'function'
description: |-
Submit personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'language_tag':
type: 'Optional[str]'
required: false
description: |-
Language tag
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'password':
type: 'str'
required: true
description: |-
IAM password of the user
'user_id':
type: 'str'
required: true
description: |-
IAM id of the user
return_type: 'Tuple[Union[None, ModelsDataRetrievalResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval/public_request_data_retrieval.py'
example: |-
result, error = gdpr.public_request_data_retrieval(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'public'
- 'request'
- 'retrieval'
'public_submit_my_account_deletion_request@py.gdpr.fun':
id: 'public_submit_my_account_deletion_request@py.gdpr.fun'
name: 'public_submit_my_account_deletion_request'
type: 'function'
description: |-
Submit my account deletion requests.
Requires valid user access token
This is for in-game only and require a valid platformId and platform token. If a full account is not logged by 3rd platform, then please use [/gdpr/public/namespaces/{namespace}/users/{userId}/deletions](#operations-Data_Deletion-PublicSubmitUserAccountDeletionRequest)
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'platform_id':
type: 'str'
required: true
description: |-
Platform ID which used to generate current token
'platform_token':
type: 'str'
required: true
description: |-
Platform token of current logged platform
return_type: 'Tuple[Union[None, ModelsRequestDeleteResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_submit_my_accoun_f5ded3.py'
example: |-
result, error = gdpr.public_submit_my_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
- 'submit'
'public_submit_user_account_deletion_request@py.gdpr.fun':
id: 'public_submit_user_account_deletion_request@py.gdpr.fun'
name: 'public_submit_user_account_deletion_request'
type: 'function'
description: |-
Submit user's account deletion request.
Requires valid user access token and password
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'language_tag':
type: 'Optional[str]'
required: false
description: |-
Language tag
'namespace':
type: 'str'
required: true
description: |-
namespace of the user
'password':
type: 'str'
required: true
description: |-
IAM password of the user
'user_id':
type: 'str'
required: true
description: |-
IAM ID of the user
return_type: 'Tuple[Union[None, ModelsRequestDeleteResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion/public_submit_user_acco_a6db4f.py'
example: |-
result, error = gdpr.public_submit_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'submit'
- 'user'
's2s_generate_personal_data_url@py.gdpr.fun':
id: 's2s_generate_personal_data_url@py.gdpr.fun'
name: 's2s_generate_personal_data_url'
type: 'function'
description: |-
Scope: account
Generate personal data download url.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
arguments:
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'request_date':
type: 'str'
required: true
description: |-
Request date in RFC3339 format
'user_id':
type: 'str'
required: true
description: |-
Publisher User Id
return_type: 'Tuple[Union[None, ModelsS2SUserDataURL], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval_s2s/s2s_generate_personal_data_url.py'
example: |-
result, error = gdpr.s2s_generate_personal_data_url(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 's2s'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
's2s_get_data_request_by_request_id@py.gdpr.fun':
id: 's2s_get_data_request_by_request_id@py.gdpr.fun'
name: 's2s_get_data_request_by_request_id'
type: 'function'
description: |-
Scope: account
Get Personal Data Request by Request Id.
If the request has been completed, it will return a download url for the data package.
---
## This API for S2S integration purpose only
arguments:
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'request_id':
type: 'str'
required: true
description: |-
Request Id
return_type: 'Tuple[Union[None, DtoS2SDataRequestSummary], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval_s2s/s2s_get_data_request_by_21f4a4.py'
example: |-
result, error = gdpr.s2s_get_data_request_by_request_id(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'data'
- 'get'
- 'id'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
's2s_get_list_finished_account_deletion_request@py.gdpr.fun':
id: 's2s_get_list_finished_account_deletion_request@py.gdpr.fun'
name: 's2s_get_list_finished_account_deletion_request'
type: 'function'
description: |-
Scope: account
Get list of finished account deletion requests based on the finished time period.
Unfinished deletion requests will not appear here, i.e. have Status **Request**, **Pending** or **In-Progress**.
**Anonymize userId for deleted account:**
For user accounts that have been deleted, the **userId** field in this API will be anonymized automatically after **7 days** from the success deletion.
This measure is implemented to ensure compliance with GDPR regulations. Please make sure to synchronize the data from this API before it undergoes anonymization.
---
## This API for S2S integration purpose only
arguments:
'end':
type: 'str'
required: true
description: |-
Finished end time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Cannot exceed current time. End time is exclusive
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'start':
type: 'str'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
return_type: 'Tuple[Union[None, DtoListFinishedDataDeletion], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion_s2s/s2s_get_list_finished_a_52b7a0.py'
example: |-
result, error = gdpr.s2s_get_list_finished_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'finished'
- 'get'
- 'list'
- 'request'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
's2s_get_list_finished_personal_data_request@py.gdpr.fun':
id: 's2s_get_list_finished_personal_data_request@py.gdpr.fun'
name: 's2s_get_list_finished_personal_data_request'
type: 'function'
description: |-
Scope: account
Get list of finished personal data requests based on the finished time period.
Unfinished personal data requests will not appear here, i.e. have Status **Pending**, **In-Progress** or **Canceled**.
**Anonymize userId for deleted account:**
For user accounts that have been deleted, the **userId** field in this API will be anonymized automatically after **7 days** from the success deletion.
This measure is implemented to ensure compliance with GDPR regulations. Please make sure to synchronize the data from this API before it undergoes anonymization.
---
## This API for S2S integration purpose only
arguments:
'end':
type: 'str'
required: true
description: |-
Finished end time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Cannot exceed current time. End time is exclusive
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'start':
type: 'str'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
return_type: 'Tuple[Union[None, DtoListFinishedDataRequests], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval_s2s/s2s_get_list_finished_p_06385b.py'
example: |-
result, error = gdpr.s2s_get_list_finished_personal_data_request(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'finished'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
's2s_request_data_retrieval@py.gdpr.fun':
id: 's2s_request_data_retrieval@py.gdpr.fun'
name: 's2s_request_data_retrieval'
type: 'function'
description: |-
Scope: account
Submit user personal data retrieval request.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
**Notes:**
1. This API will **not send GDPR email notification** both for player and admin notification.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'user_id':
type: 'str'
required: true
description: |-
Publisher User Id
return_type: 'Tuple[Union[None, ModelsS2SDataRetrievalResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_retrieval_s2s/s2s_request_data_retrieval.py'
example: |-
result, error = gdpr.s2s_request_data_retrieval(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
's2s_submit_user_account_deletion_request@py.gdpr.fun':
id: 's2s_submit_user_account_deletion_request@py.gdpr.fun'
name: 's2s_submit_user_account_deletion_request'
type: 'function'
description: |-
Scope: account
Submit user's account deletion request.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
**Notes:**
1. This API will **not send GDPR email notification** both for player and admin notification.
2. This API will **perform account deletion immediately** without GDPR grace period (i.e. 28 days grace period).
arguments:
'namespace':
type: 'str'
required: true
description: |-
Publisher Namespace
'user_id':
type: 'str'
required: true
description: |-
Publisher User Id
return_type: 'Tuple[Union[None, ModelsS2SRequestDeleteResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/data_deletion_s2s/s2s_submit_user_account_5c299d.py'
example: |-
result, error = gdpr.s2s_submit_user_account_deletion_request(...)
if error:
# handle_error(error)
tags:
- 'account'
- 'data'
- 'deletion'
- 'request'
- 's2s'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
'save_admin_email_configuration@py.gdpr.fun':
id: 'save_admin_email_configuration@py.gdpr.fun'
name: 'save_admin_email_configuration'
type: 'function'
description: |-
Add admin email address for receiving personal data request notification.
Scope: account
arguments:
'body':
type: 'List[str]'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/save_admin_email_configuration.py'
example: |-
result, error = gdpr.save_admin_email_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'email'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [CREATE]'
'update_admin_email_configuration@py.gdpr.fun':
id: 'update_admin_email_configuration@py.gdpr.fun'
name: 'update_admin_email_configuration'
type: 'function'
description: |-
Update admin email address for receiving personal data request notification.
Scope: account
arguments:
'body':
type: 'List[str]'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.gdpr as gdpr'
- 'import accelbyte_py_sdk.api.gdpr.models as gdpr_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/gdpr/operations/configuration/update_admin_email_conf_71e966.py'
example: |-
result, error = gdpr.update_admin_email_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'email'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [UPDATE]'
# endregion functions
