symbols:
'NewGdprClient@go.gdpr.fun':
id: 'NewGdprClient@go.gdpr.fun'
name: 'NewGdprClient'
type: 'function'
arguments:
configRepository:
type: 'repository.ConfigRepository'
return_type: '*gdprclient.JusticeGdprService'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-modular-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/justice_gdpr_service_client.go'
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/gdprclientfactory.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo)
# region wrappers
'ConfigurationService@go.gdpr.mod':
id: 'ConfigurationService@go.gdpr.mod'
name: 'ConfigurationService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
configurationService := ConfigurationService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'DataDeletionService@go.gdpr.mod':
id: 'DataDeletionService@go.gdpr.mod'
name: 'DataDeletionService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
dataDeletionService := DataDeletionService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'DataDeletionS2SService@go.gdpr.mod':
id: 'DataDeletionS2SService@go.gdpr.mod'
name: 'DataDeletionS2SService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletionS2S.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
dataDeletionS2SService := DataDeletionS2SService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'DataRetrievalService@go.gdpr.mod':
id: 'DataRetrievalService@go.gdpr.mod'
name: 'DataRetrievalService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
dataRetrievalService := DataRetrievalService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'DataRetrievalS2SService@go.gdpr.mod':
id: 'DataRetrievalS2SService@go.gdpr.mod'
name: 'DataRetrievalS2SService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrievalS2S.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
dataRetrievalS2SService := DataRetrievalS2SService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'PlatformAccountClosureClientService@go.gdpr.mod':
id: 'PlatformAccountClosureClientService@go.gdpr.mod'
name: 'PlatformAccountClosureClientService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
platformAccountClosureClientService := PlatformAccountClosureClientService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'PlatformAccountClosureHistoryService@go.gdpr.mod':
id: 'PlatformAccountClosureHistoryService@go.gdpr.mod'
name: 'PlatformAccountClosureHistoryService'
type: 'model'
fields:
Client:
type: '*gdprclient.JusticeGdprService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureHistory.go'
example: |-
gdprClient := factory.NewGdprClient(configRepo) // re-use if it exists already
platformAccountClosureHistoryService := PlatformAccountClosureHistoryService{
Client: gdprClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
# endregion wrappers
# region params
'AdminCancelUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'AdminCancelUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'AdminCancelUserAccountDeletionRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/admin_cancel_user_account_deletion_request_parameters.go'
'AdminCancelUserPersonalDataRequestParams@go.gdpr.mod':
id: 'AdminCancelUserPersonalDataRequestParams@go.gdpr.mod'
name: 'AdminCancelUserPersonalDataRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'RequestDate':
type: 'string'
required: true
description: |-
Request date in RFC3339 format
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/admin_cancel_user_personal_data_request_parameters.go'
'AdminDeletePlatformAccountClosureClientParams@go.gdpr.mod':
id: 'AdminDeletePlatformAccountClosureClientParams@go.gdpr.mod'
name: 'AdminDeletePlatformAccountClosureClientParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Platform':
type: 'string'
required: true
description: |-
3rd party platform
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_delete_platform_account_closure_client_parameters.go'
'AdminGeneratePersonalDataURLParams@go.gdpr.mod':
id: 'AdminGeneratePersonalDataURLParams@go.gdpr.mod'
name: 'AdminGeneratePersonalDataURLParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Password':
type: 'string'
required: false
description: |-
If admin request data for themselves, then password is required
'RequestDate':
type: 'string'
required: true
description: |-
Request date in RFC3339 format
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/admin_generate_personal_data_url_parameters.go'
'AdminGetListDeletionDataRequestParams@go.gdpr.mod':
id: 'AdminGetListDeletionDataRequestParams@go.gdpr.mod'
name: 'AdminGetListDeletionDataRequestParams'
type: 'model'
fields:
'After':
type: 'string'
required: false
description: |-
The day in UTC format to get deletion request list after that. format : YYYY-MM-DD
'Before':
type: 'string'
required: false
description: |-
The day in UTC format to get deletion request list before that. format : YYYY-MM-DD
'Limit':
type: 'int64'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
The start position that points to query data
'RequestDate':
type: 'string'
required: false
description: |-
The day in UTC of the deletion request. format : YYYY-MM-DD. Default : today time in UTC.
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/admin_get_list_deletion_data_request_parameters.go'
'AdminGetListPersonalDataRequestParams@go.gdpr.mod':
id: 'AdminGetListPersonalDataRequestParams@go.gdpr.mod'
name: 'AdminGetListPersonalDataRequestParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
The start position that points to query data
'RequestDate':
type: 'string'
required: false
description: |-
request date with format YYYY-MM-DD. Default value today UTC
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/admin_get_list_personal_data_request_parameters.go'
'AdminGetPlatformAccountClosureClientParams@go.gdpr.mod':
id: 'AdminGetPlatformAccountClosureClientParams@go.gdpr.mod'
name: 'AdminGetPlatformAccountClosureClientParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Platform':
type: 'string'
required: true
description: |-
3rd party platform
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_get_platform_account_closure_client_parameters.go'
'AdminGetPlatformAccountClosureClientsParams@go.gdpr.mod':
id: 'AdminGetPlatformAccountClosureClientsParams@go.gdpr.mod'
name: 'AdminGetPlatformAccountClosureClientsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_get_platform_account_closure_clients_parameters.go'
'AdminGetPlatformAccountClosureServicesConfigurationParams@go.gdpr.mod':
id: 'AdminGetPlatformAccountClosureServicesConfigurationParams@go.gdpr.mod'
name: 'AdminGetPlatformAccountClosureServicesConfigurationParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_get_platform_account_closure_services_configuration_parameters.go'
'AdminGetServicesConfigurationParams@go.gdpr.mod':
id: 'AdminGetServicesConfigurationParams@go.gdpr.mod'
name: 'AdminGetServicesConfigurationParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_get_services_configuration_parameters.go'
'AdminGetUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'AdminGetUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'AdminGetUserAccountDeletionRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/admin_get_user_account_deletion_request_parameters.go'
'AdminGetUserPersonalDataRequestsParams@go.gdpr.mod':
id: 'AdminGetUserPersonalDataRequestsParams@go.gdpr.mod'
name: 'AdminGetUserPersonalDataRequestsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
The start position that points to query data
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/admin_get_user_personal_data_requests_parameters.go'
'AdminGetUserPlatformAccountClosureHistoriesParams@go.gdpr.mod':
id: 'AdminGetUserPlatformAccountClosureHistoriesParams@go.gdpr.mod'
name: 'AdminGetUserPlatformAccountClosureHistoriesParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'Platform':
type: 'string'
required: false
description: |-
3rd party platform
'UserID':
type: 'string'
required: false
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_history'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_history/admin_get_user_platform_account_closure_histories_parameters.go'
'AdminMockPlatformAccountClosureDataParams@go.gdpr.mod':
id: 'AdminMockPlatformAccountClosureDataParams@go.gdpr.mod'
name: 'AdminMockPlatformAccountClosureDataParams'
type: 'model'
fields:
'Body':
type: '*DTOPlatformAccountClosureMockRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Platform':
type: 'string'
required: true
description: |-
3rd party platform
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_mock_platform_account_closure_data_parameters.go'
'AdminRequestDataRetrievalParams@go.gdpr.mod':
id: 'AdminRequestDataRetrievalParams@go.gdpr.mod'
name: 'AdminRequestDataRetrievalParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Password':
type: 'string'
required: false
description: |-
IAM password of the user, required if admin requests their own data
'UserID':
type: 'string'
required: true
description: |-
IAM user ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/admin_request_data_retrieval_parameters.go'
'AdminResetPlatformAccountClosureServicesConfigurationParams@go.gdpr.mod':
id: 'AdminResetPlatformAccountClosureServicesConfigurationParams@go.gdpr.mod'
name: 'AdminResetPlatformAccountClosureServicesConfigurationParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_reset_platform_account_closure_services_configuration_parameters.go'
'AdminResetServicesConfigurationParams@go.gdpr.mod':
id: 'AdminResetServicesConfigurationParams@go.gdpr.mod'
name: 'AdminResetServicesConfigurationParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_reset_services_configuration_parameters.go'
'AdminSubmitUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'AdminSubmitUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'AdminSubmitUserAccountDeletionRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/admin_submit_user_account_deletion_request_parameters.go'
'AdminUpdatePlatformAccountClosureClientParams@go.gdpr.mod':
id: 'AdminUpdatePlatformAccountClosureClientParams@go.gdpr.mod'
name: 'AdminUpdatePlatformAccountClosureClientParams'
type: 'model'
fields:
'Body':
type: '*DTOPlatformAccountClosureClientRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Platform':
type: 'string'
required: true
description: |-
3rd party platform
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_update_platform_account_closure_client_parameters.go'
'AdminUpdatePlatformAccountClosureServicesConfigurationParams@go.gdpr.mod':
id: 'AdminUpdatePlatformAccountClosureServicesConfigurationParams@go.gdpr.mod'
name: 'AdminUpdatePlatformAccountClosureServicesConfigurationParams'
type: 'model'
fields:
'Body':
type: '*DTOServiceConfigurationUpdateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_update_platform_account_closure_services_configuration_parameters.go'
'AdminUpdateServicesConfigurationParams@go.gdpr.mod':
id: 'AdminUpdateServicesConfigurationParams@go.gdpr.mod'
name: 'AdminUpdateServicesConfigurationParams'
type: 'model'
fields:
'Body':
type: '*DTOServiceConfigurationUpdateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/admin_update_services_configuration_parameters.go'
'AdminValidateXboxBPCertFileParams@go.gdpr.mod':
id: 'AdminValidateXboxBPCertFileParams@go.gdpr.mod'
name: 'AdminValidateXboxBPCertFileParams'
type: 'model'
fields:
'Body':
type: '*DTOXboxBPCertValidationRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/platform_account_closure_client/admin_validate_xbox_b_p_cert_file_parameters.go'
'DeleteAdminEmailConfigurationParams@go.gdpr.mod':
id: 'DeleteAdminEmailConfigurationParams@go.gdpr.mod'
name: 'DeleteAdminEmailConfigurationParams'
type: 'model'
fields:
'Emails':
type: '[]string'
required: true
description: |-
list of admin email to delete
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/delete_admin_email_configuration_parameters.go'
'GetAdminEmailConfigurationParams@go.gdpr.mod':
id: 'GetAdminEmailConfigurationParams@go.gdpr.mod'
name: 'GetAdminEmailConfigurationParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/get_admin_email_configuration_parameters.go'
'PublicCancelMyAccountDeletionRequestParams@go.gdpr.mod':
id: 'PublicCancelMyAccountDeletionRequestParams@go.gdpr.mod'
name: 'PublicCancelMyAccountDeletionRequestParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_cancel_my_account_deletion_request_parameters.go'
'PublicCancelUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'PublicCancelUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'PublicCancelUserAccountDeletionRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_cancel_user_account_deletion_request_parameters.go'
'PublicCancelUserPersonalDataRequestParams@go.gdpr.mod':
id: 'PublicCancelUserPersonalDataRequestParams@go.gdpr.mod'
name: 'PublicCancelUserPersonalDataRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'RequestDate':
type: 'string'
required: true
description: |-
Request date in RFC3339 format
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/public_cancel_user_personal_data_request_parameters.go'
'PublicGeneratePersonalDataURLParams@go.gdpr.mod':
id: 'PublicGeneratePersonalDataURLParams@go.gdpr.mod'
name: 'PublicGeneratePersonalDataURLParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'Password':
type: 'string'
required: true
description: |-
IAM password of the user
'RequestDate':
type: 'string'
required: true
description: |-
Request date in RFC3339 format
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/public_generate_personal_data_url_parameters.go'
'PublicGetMyAccountDeletionStatusParams@go.gdpr.mod':
id: 'PublicGetMyAccountDeletionStatusParams@go.gdpr.mod'
name: 'PublicGetMyAccountDeletionStatusParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_get_my_account_deletion_status_parameters.go'
'PublicGetUserAccountDeletionStatusParams@go.gdpr.mod':
id: 'PublicGetUserAccountDeletionStatusParams@go.gdpr.mod'
name: 'PublicGetUserAccountDeletionStatusParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_get_user_account_deletion_status_parameters.go'
'PublicGetUserPersonalDataRequestsParams@go.gdpr.mod':
id: 'PublicGetUserPersonalDataRequestsParams@go.gdpr.mod'
name: 'PublicGetUserPersonalDataRequestsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'Offset':
type: 'int64'
required: false
description: |-
The start position that points to query data
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/public_get_user_personal_data_requests_parameters.go'
'PublicRequestDataRetrievalParams@go.gdpr.mod':
id: 'PublicRequestDataRetrievalParams@go.gdpr.mod'
name: 'PublicRequestDataRetrievalParams'
type: 'model'
fields:
'LanguageTag':
type: 'string'
required: false
description: |-
Language tag
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'Password':
type: 'string'
required: true
description: |-
IAM password of the user
'UserID':
type: 'string'
required: true
description: |-
IAM id of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval/public_request_data_retrieval_parameters.go'
'PublicSubmitMyAccountDeletionRequestParams@go.gdpr.mod':
id: 'PublicSubmitMyAccountDeletionRequestParams@go.gdpr.mod'
name: 'PublicSubmitMyAccountDeletionRequestParams'
type: 'model'
fields:
'PlatformID':
type: 'string'
required: true
description: |-
Platform ID which used to generate current token
'PlatformToken':
type: 'string'
required: true
description: |-
Platform token of current logged platform
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_submit_my_account_deletion_request_parameters.go'
'PublicSubmitUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'PublicSubmitUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'PublicSubmitUserAccountDeletionRequestParams'
type: 'model'
fields:
'LanguageTag':
type: 'string'
required: false
description: |-
Language tag
'Namespace':
type: 'string'
required: true
description: |-
namespace of the user
'Password':
type: 'string'
required: true
description: |-
IAM password of the user
'UserID':
type: 'string'
required: true
description: |-
IAM ID of the user
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion/public_submit_user_account_deletion_request_parameters.go'
'S2SGeneratePersonalDataURLParams@go.gdpr.mod':
id: 'S2SGeneratePersonalDataURLParams@go.gdpr.mod'
name: 'S2SGeneratePersonalDataURLParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
Publisher Namespace
'RequestDate':
type: 'string'
required: true
description: |-
Request date in RFC3339 format
'UserID':
type: 'string'
required: true
description: |-
Publisher User Id
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s/s2_s_generate_personal_data_url_parameters.go'
'S2SGetDataRequestByRequestIDParams@go.gdpr.mod':
id: 'S2SGetDataRequestByRequestIDParams@go.gdpr.mod'
name: 'S2SGetDataRequestByRequestIDParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
Publisher Namespace
'RequestID':
type: 'string'
required: true
description: |-
Request Id
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s/s2_s_get_data_request_by_request_id_parameters.go'
'S2SGetListFinishedAccountDeletionRequestParams@go.gdpr.mod':
id: 'S2SGetListFinishedAccountDeletionRequestParams@go.gdpr.mod'
name: 'S2SGetListFinishedAccountDeletionRequestParams'
type: 'model'
fields:
'End':
type: 'string'
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: 'string'
required: true
description: |-
Publisher Namespace
'Start':
type: 'string'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s/s2_s_get_list_finished_account_deletion_request_parameters.go'
'S2SGetListFinishedPersonalDataRequestParams@go.gdpr.mod':
id: 'S2SGetListFinishedPersonalDataRequestParams@go.gdpr.mod'
name: 'S2SGetListFinishedPersonalDataRequestParams'
type: 'model'
fields:
'End':
type: 'string'
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: 'string'
required: true
description: |-
Publisher Namespace
'Start':
type: 'string'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s/s2_s_get_list_finished_personal_data_request_parameters.go'
'S2SRequestDataRetrievalParams@go.gdpr.mod':
id: 'S2SRequestDataRetrievalParams@go.gdpr.mod'
name: 'S2SRequestDataRetrievalParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
Publisher Namespace
'UserID':
type: 'string'
required: true
description: |-
Publisher User Id
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s/s2_s_request_data_retrieval_parameters.go'
'S2SSubmitUserAccountDeletionRequestParams@go.gdpr.mod':
id: 'S2SSubmitUserAccountDeletionRequestParams@go.gdpr.mod'
name: 'S2SSubmitUserAccountDeletionRequestParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
Publisher Namespace
'UserID':
type: 'string'
required: true
description: |-
Publisher User Id
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s/s2_s_submit_user_account_deletion_request_parameters.go'
'SaveAdminEmailConfigurationParams@go.gdpr.mod':
id: 'SaveAdminEmailConfigurationParams@go.gdpr.mod'
name: 'SaveAdminEmailConfigurationParams'
type: 'model'
fields:
'Body':
type: '[]string'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/save_admin_email_configuration_parameters.go'
'UpdateAdminEmailConfigurationParams@go.gdpr.mod':
id: 'UpdateAdminEmailConfigurationParams@go.gdpr.mod'
name: 'UpdateAdminEmailConfigurationParams'
type: 'model'
fields:
'Body':
type: '[]string'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclient/configuration/update_admin_email_configuration_parameters.go'
# endregion params
# region models
'DTOExtendConfigDTO@go.gdpr.mod':
id: 'DTOExtendConfigDTO@go.gdpr.mod'
name: 'DTOExtendConfigDTO'
type: 'model'
fields:
'AppName':
type: 'string'
required: true
description: |-
extend app name
'Namespace':
type: 'string'
required: true
description: |-
extend app namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_extend_config_dto.go'
'DTOFinishedDataDeletion@go.gdpr.mod':
id: 'DTOFinishedDataDeletion@go.gdpr.mod'
name: 'DTOFinishedDataDeletion'
type: 'model'
fields:
'FailedMessage':
type: 'string'
required: false
description: |-
Failed message if status is Failed
'FinishedDate':
type: 'strfmt.DateTime'
required: true
description: |-
Finished deletion date
'RequestDate':
type: 'strfmt.DateTime'
required: true
description: |-
Request deletion date
'Status':
type: 'string'
required: true
description: |-
Status of request
'UserID':
type: 'string'
required: true
description: |-
User Id. This userId will be anonymized automatically after 7 days from the **Success** deletion
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_finished_data_deletion.go'
'DTOFinishedDataRequest@go.gdpr.mod':
id: 'DTOFinishedDataRequest@go.gdpr.mod'
name: 'DTOFinishedDataRequest'
type: 'model'
fields:
'DataExpirationDate':
type: '*strfmt.DateTime'
required: false
description: |-
The expiration date of generated data, it was 28 days after finishedDate. Available only if the status is Completed
'FailedMessage':
type: 'string'
required: false
description: |-
Failed message if status is Failed
'FinishedDate':
type: 'strfmt.DateTime'
required: true
description: |-
Finished date
'RequestDate':
type: 'strfmt.DateTime'
required: true
description: |-
Request date
'RequestID':
type: 'string'
required: true
description: |-
Request id
'Status':
type: 'string'
required: true
description: |-
Status of request
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_finished_data_request.go'
'DTOListFinishedDataDeletion@go.gdpr.mod':
id: 'DTOListFinishedDataDeletion@go.gdpr.mod'
name: 'DTOListFinishedDataDeletion'
type: 'model'
fields:
'Data':
type: '[]*DTOFinishedDataDeletion'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_list_finished_data_deletion.go'
'DTOListFinishedDataRequests@go.gdpr.mod':
id: 'DTOListFinishedDataRequests@go.gdpr.mod'
name: 'DTOListFinishedDataRequests'
type: 'model'
fields:
'Data':
type: '[]*DTOFinishedDataRequest'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_list_finished_data_requests.go'
'DTOPlatformAccountClosureClientRequest@go.gdpr.mod':
id: 'DTOPlatformAccountClosureClientRequest@go.gdpr.mod'
name: 'DTOPlatformAccountClosureClientRequest'
type: 'model'
fields:
'BpCert':
type: 'string'
required: false
description: |-
required for xbox
'BpCertFileName':
type: 'string'
required: false
description: |-
required for xbox
'ClientID':
type: 'string'
required: false
description: |-
required for psn
'Password':
type: 'string'
required: false
description: |-
required for xbox
'PublisherKey':
type: 'string'
required: false
description: |-
required for steam
'SandboxID':
type: 'string'
required: false
description: |-
required for xbox
'Secret':
type: 'string'
required: false
description: |-
required for psn
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_platform_account_closure_client_request.go'
'DTOPlatformAccountClosureClientResponse@go.gdpr.mod':
id: 'DTOPlatformAccountClosureClientResponse@go.gdpr.mod'
name: 'DTOPlatformAccountClosureClientResponse'
type: 'model'
fields:
'BpCertExpireAt':
type: 'int64'
required: false
'BpCertFileName':
type: 'string'
required: false
'ClientID':
type: 'string'
required: false
'Namespace':
type: 'string'
required: true
'Platform':
type: 'string'
required: true
'PublisherKey':
type: 'string'
required: false
'SandboxID':
type: 'string'
required: false
'Secret':
type: 'string'
required: false
'UpdatedAt':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_platform_account_closure_client_response.go'
'DTOPlatformAccountClosureClientsResponse@go.gdpr.mod':
id: 'DTOPlatformAccountClosureClientsResponse@go.gdpr.mod'
name: 'DTOPlatformAccountClosureClientsResponse'
type: 'model'
fields:
'Data':
type: '[]*DTOPlatformAccountClosureClientResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_platform_account_closure_clients_response.go'
'DTOPlatformAccountClosureMockRequest@go.gdpr.mod':
id: 'DTOPlatformAccountClosureMockRequest@go.gdpr.mod'
name: 'DTOPlatformAccountClosureMockRequest'
type: 'model'
fields:
'PlatformUserID':
type: 'string'
required: true
'Sandbox':
type: 'string'
required: true
'StartImmediately':
type: 'bool'
required: true
description: |-
start the account closure process immediately
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_platform_account_closure_mock_request.go'
'DTOS2SDataRequestSummary@go.gdpr.mod':
id: 'DTOS2SDataRequestSummary@go.gdpr.mod'
name: 'DTOS2SDataRequestSummary'
type: 'model'
fields:
'FailedMessage':
type: 'string'
required: false
description: |-
Failed message if status is Failed
'Status':
type: 'string'
required: true
description: |-
Status of the request
'URL':
type: 'string'
required: false
description: |-
Download url if status is Completed
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_s2_s_data_request_summary.go'
'DTOServiceConfigDTO@go.gdpr.mod':
id: 'DTOServiceConfigDTO@go.gdpr.mod'
name: 'DTOServiceConfigDTO'
type: 'model'
fields:
'Protocol':
type: 'string'
required: true
description: |-
protocol type
'SkipAck':
type: 'bool'
required: false
description: |-
skip waiting for ack event from this service, used in "EVENT" protocol only.
'URL':
type: 'string'
required: false
description: |-
url of the service with port number, required in "GRPC" protocol
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_service_config_dto.go'
'DTOServiceConfigurationDTO@go.gdpr.mod':
id: 'DTOServiceConfigurationDTO@go.gdpr.mod'
name: 'DTOServiceConfigurationDTO'
type: 'model'
fields:
'ExtendConfig':
type: '*DTOExtendConfigDTO'
required: false
description: |-
extend configuration detail, required when "type" is "EXTEND"
'ID':
type: 'string'
required: true
description: |-
service id
'ServiceConfig':
type: '*DTOServiceConfigDTO'
required: false
description: |-
service configuration detail, required when "type" is "SERVICE"
'Type':
type: 'string'
required: true
description: |-
service type
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_service_configuration_dto.go'
'DTOServiceConfigurationUpdateRequest@go.gdpr.mod':
id: 'DTOServiceConfigurationUpdateRequest@go.gdpr.mod'
name: 'DTOServiceConfigurationUpdateRequest'
type: 'model'
fields:
'Services':
type: '[]*DTOServiceConfigurationDTO'
required: true
description: |-
list of services
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_service_configuration_update_request.go'
'DTOServicesConfigurationResponse@go.gdpr.mod':
id: 'DTOServicesConfigurationResponse@go.gdpr.mod'
name: 'DTOServicesConfigurationResponse'
type: 'model'
fields:
'Services':
type: '[]*DTOServiceConfigurationDTO'
required: true
description: |-
list of services
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_services_configuration_response.go'
'DTOUserPlatformAccountClosureHistoriesResponse@go.gdpr.mod':
id: 'DTOUserPlatformAccountClosureHistoriesResponse@go.gdpr.mod'
name: 'DTOUserPlatformAccountClosureHistoriesResponse'
type: 'model'
fields:
'Data':
type: '[]*DTOUserPlatformAccountClosureHistory'
required: true
'Pagination':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_user_platform_account_closure_histories_response.go'
'DTOUserPlatformAccountClosureHistory@go.gdpr.mod':
id: 'DTOUserPlatformAccountClosureHistory@go.gdpr.mod'
name: 'DTOUserPlatformAccountClosureHistory'
type: 'model'
fields:
'ClosedDate':
type: 'int64'
required: true
'Environment':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Platform':
type: 'string'
required: true
'PlatformUserID':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_user_platform_account_closure_history.go'
'DTOXboxBPCertValidationRequest@go.gdpr.mod':
id: 'DTOXboxBPCertValidationRequest@go.gdpr.mod'
name: 'DTOXboxBPCertValidationRequest'
type: 'model'
fields:
'BpCert':
type: 'string'
required: true
'Password':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_xbox_b_p_cert_validation_request.go'
'DTOXboxBPCertValidationResponse@go.gdpr.mod':
id: 'DTOXboxBPCertValidationResponse@go.gdpr.mod'
name: 'DTOXboxBPCertValidationResponse'
type: 'model'
fields:
'ExpirationDate':
type: 'int64'
required: true
'Expired':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/dto_xbox_b_p_cert_validation_response.go'
'ModelsDataRetrievalResponse@go.gdpr.mod':
id: 'ModelsDataRetrievalResponse@go.gdpr.mod'
name: 'ModelsDataRetrievalResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'RequestDate':
type: 'strfmt.DateTime'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_data_retrieval_response.go'
'ModelsDeletionData@go.gdpr.mod':
id: 'ModelsDeletionData@go.gdpr.mod'
name: 'ModelsDeletionData'
type: 'model'
fields:
'DisplayName':
type: 'string'
required: true
'RequestDate':
type: 'strfmt.DateTime'
required: true
'Status':
type: 'string'
required: true
'UniqueDisplayName':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_deletion_data.go'
'ModelsDeletionStatus@go.gdpr.mod':
id: 'ModelsDeletionStatus@go.gdpr.mod'
name: 'ModelsDeletionStatus'
type: 'model'
fields:
'DeletionDate':
type: 'string'
required: true
'DeletionStatus':
type: 'bool'
required: true
'DisplayName':
type: 'string'
required: true
'ExecutionDate':
type: '*strfmt.DateTime'
required: false
'Status':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_deletion_status.go'
'ModelsListDeletionDataResponse@go.gdpr.mod':
id: 'ModelsListDeletionDataResponse@go.gdpr.mod'
name: 'ModelsListDeletionDataResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsDeletionData'
required: true
'Paging':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_list_deletion_data_response.go'
'ModelsListPersonalDataResponse@go.gdpr.mod':
id: 'ModelsListPersonalDataResponse@go.gdpr.mod'
name: 'ModelsListPersonalDataResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsPersonalData'
required: true
'Paging':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_list_personal_data_response.go'
'ModelsPagination@go.gdpr.mod':
id: 'ModelsPagination@go.gdpr.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'First':
type: 'string'
required: true
'Last':
type: 'string'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_pagination.go'
'ModelsPersonalData@go.gdpr.mod':
id: 'ModelsPersonalData@go.gdpr.mod'
name: 'ModelsPersonalData'
type: 'model'
fields:
'DataExpirationDate':
type: 'strfmt.DateTime'
required: true
'DisplayName':
type: 'string'
required: true
'RequestDate':
type: 'strfmt.DateTime'
required: true
'ServiceErrors':
type: 'map[string]string'
required: true
'ServiceStatuses':
type: 'map[string]string'
required: true
'Status':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_personal_data.go'
'ModelsRequestDeleteResponse@go.gdpr.mod':
id: 'ModelsRequestDeleteResponse@go.gdpr.mod'
name: 'ModelsRequestDeleteResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_request_delete_response.go'
'ModelsS2SDataRetrievalResponse@go.gdpr.mod':
id: 'ModelsS2SDataRetrievalResponse@go.gdpr.mod'
name: 'ModelsS2SDataRetrievalResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'RequestDate':
type: 'strfmt.DateTime'
required: true
'RequestID':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_s2_s_data_retrieval_response.go'
'ModelsS2SRequestDeleteResponse@go.gdpr.mod':
id: 'ModelsS2SRequestDeleteResponse@go.gdpr.mod'
name: 'ModelsS2SRequestDeleteResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_s2_s_request_delete_response.go'
'ModelsS2SUserDataURL@go.gdpr.mod':
id: 'ModelsS2SUserDataURL@go.gdpr.mod'
name: 'ModelsS2SUserDataURL'
type: 'model'
fields:
'URL':
type: 'string'
required: true
description: |-
Download url if status is Completed
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_s2_s_user_data_url.go'
'ModelsUserDataURL@go.gdpr.mod':
id: 'ModelsUserDataURL@go.gdpr.mod'
name: 'ModelsUserDataURL'
type: 'model'
fields:
'URL':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_user_data_url.go'
'ModelsUserPersonalData@go.gdpr.mod':
id: 'ModelsUserPersonalData@go.gdpr.mod'
name: 'ModelsUserPersonalData'
type: 'model'
fields:
'DataExpirationDate':
type: 'strfmt.DateTime'
required: true
'RequestDate':
type: 'strfmt.DateTime'
required: true
'Status':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_user_personal_data.go'
'ModelsUserPersonalDataResponse@go.gdpr.mod':
id: 'ModelsUserPersonalDataResponse@go.gdpr.mod'
name: 'ModelsUserPersonalDataResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsUserPersonalData'
required: true
'Paging':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/models_user_personal_data_response.go'
'ResponseError@go.gdpr.mod':
id: 'ResponseError@go.gdpr.mod'
name: 'ResponseError'
type: 'model'
fields:
'ErrorCode':
type: 'int32'
required: true
'ErrorMessage':
type: 'string'
required: true
'MessageVariables':
type: 'map[string]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/gdpr-sdk/pkg/gdprclientmodels/response_error.go'
# endregion models
# region functions
'AdminCancelUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'AdminCancelUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'AdminCancelUserAccountDeletionRequestShort'
type: 'function'
description: |-
Cancel user's account deletion request
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.AdminCancelUserAccountDeletionRequestParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.AdminCancelUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.AdminCancelUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'cancel'
- 'data'
- 'deletion'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'AdminCancelUserPersonalDataRequestShort@go.gdpr.fun':
id: 'AdminCancelUserPersonalDataRequestShort@go.gdpr.fun'
name: 'AdminCancelUserPersonalDataRequestShort'
type: 'function'
description: |-
Cancel user's personal data requests
Scope: account
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.AdminCancelUserPersonalDataRequestParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.AdminCancelUserPersonalDataRequestParams{ ... }
res, err := dataRetrievalService.AdminCancelUserPersonalDataRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'cancel'
- 'data'
- 'personal'
- 'request'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'AdminDeletePlatformAccountClosureClientShort@go.gdpr.fun':
id: 'AdminDeletePlatformAccountClosureClientShort@go.gdpr.fun'
name: 'AdminDeletePlatformAccountClosureClientShort'
type: 'function'
description: |-
Delete platform account closure client.
The namespace should be **publisher or studio namespace**
-------
Platform:
- steamnetwork
- xbox
- psn
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminDeletePlatformAccountClosureClientParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminDeletePlatformAccountClosureClientParams{ ... }
res, err := platformAccountClosureClientService.AdminDeletePlatformAccountClosureClientShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'delete'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminGeneratePersonalDataURLShort@go.gdpr.fun':
id: 'AdminGeneratePersonalDataURLShort@go.gdpr.fun'
name: 'AdminGeneratePersonalDataURLShort'
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
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.AdminGeneratePersonalDataURLParams'
required: true
return_type: '(*data_retrieval.AdminGeneratePersonalDataURLResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.AdminGeneratePersonalDataURLParams{ ... }
res, err := dataRetrievalService.AdminGeneratePersonalDataURLShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetListDeletionDataRequestShort@go.gdpr.fun':
id: 'AdminGetListDeletionDataRequestShort@go.gdpr.fun'
name: 'AdminGetListDeletionDataRequestShort'
type: 'function'
description: |-
Retrieve all user's account deletion requests in specified date
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.AdminGetListDeletionDataRequestParams'
required: true
return_type: '(*data_deletion.AdminGetListDeletionDataRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.AdminGetListDeletionDataRequestParams{ ... }
res, err := dataDeletionService.AdminGetListDeletionDataRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'list'
- 'request'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'AdminGetListPersonalDataRequestShort@go.gdpr.fun':
id: 'AdminGetListPersonalDataRequestShort@go.gdpr.fun'
name: 'AdminGetListPersonalDataRequestShort'
type: 'function'
description: |-
Get list personal data requests
Scope: account
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.AdminGetListPersonalDataRequestParams'
required: true
return_type: '(*data_retrieval.AdminGetListPersonalDataRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.AdminGetListPersonalDataRequestParams{ ... }
res, err := dataRetrievalService.AdminGetListPersonalDataRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'data'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'AdminGetPlatformAccountClosureClientShort@go.gdpr.fun':
id: 'AdminGetPlatformAccountClosureClientShort@go.gdpr.fun'
name: 'AdminGetPlatformAccountClosureClientShort'
type: 'function'
description: |-
Get platform account closure config.
The namespace should be **publisher or studio namespace**
----------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminGetPlatformAccountClosureClientParams'
required: true
return_type: '(*platform_account_closure_client.AdminGetPlatformAccountClosureClientResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminGetPlatformAccountClosureClientParams{ ... }
res, err := platformAccountClosureClientService.AdminGetPlatformAccountClosureClientShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetPlatformAccountClosureClientsShort@go.gdpr.fun':
id: 'AdminGetPlatformAccountClosureClientsShort@go.gdpr.fun'
name: 'AdminGetPlatformAccountClosureClientsShort'
type: 'function'
description: |-
Get platform account closure configs.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminGetPlatformAccountClosureClientsParams'
required: true
return_type: '(*platform_account_closure_client.AdminGetPlatformAccountClosureClientsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminGetPlatformAccountClosureClientsParams{ ... }
res, err := platformAccountClosureClientService.AdminGetPlatformAccountClosureClientsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'client'
- 'clients'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetPlatformAccountClosureServicesConfigurationShort@go.gdpr.fun':
id: 'AdminGetPlatformAccountClosureServicesConfigurationShort@go.gdpr.fun'
name: 'AdminGetPlatformAccountClosureServicesConfigurationShort'
type: 'function'
description: |-
Get registered platform account closure services configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminGetPlatformAccountClosureServicesConfigurationParams'
required: true
return_type: '(*configuration.AdminGetPlatformAccountClosureServicesConfigurationResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminGetPlatformAccountClosureServicesConfigurationParams{ ... }
res, err := configurationService.AdminGetPlatformAccountClosureServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'get'
- 'platform'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetServicesConfigurationShort@go.gdpr.fun':
id: 'AdminGetServicesConfigurationShort@go.gdpr.fun'
name: 'AdminGetServicesConfigurationShort'
type: 'function'
description: |-
Get Registered Services Configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminGetServicesConfigurationParams'
required: true
return_type: '(*configuration.AdminGetServicesConfigurationResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminGetServicesConfigurationParams{ ... }
res, err := configurationService.AdminGetServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'get'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'AdminGetUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'AdminGetUserAccountDeletionRequestShort'
type: 'function'
description: |-
Retrieve specific user's account deletion request
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.AdminGetUserAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion.AdminGetUserAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.AdminGetUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.AdminGetUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetUserPersonalDataRequestsShort@go.gdpr.fun':
id: 'AdminGetUserPersonalDataRequestsShort@go.gdpr.fun'
name: 'AdminGetUserPersonalDataRequestsShort'
type: 'function'
description: |-
Get user's personal data requests
Scope: account
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.AdminGetUserPersonalDataRequestsParams'
required: true
return_type: '(*data_retrieval.AdminGetUserPersonalDataRequestsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.AdminGetUserPersonalDataRequestsParams{ ... }
res, err := dataRetrievalService.AdminGetUserPersonalDataRequestsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'data'
- 'get'
- 'personal'
- 'requests'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetUserPlatformAccountClosureHistoriesShort@go.gdpr.fun':
id: 'AdminGetUserPlatformAccountClosureHistoriesShort@go.gdpr.fun'
name: 'AdminGetUserPlatformAccountClosureHistoriesShort'
type: 'function'
description: |-
Get user's platform account closure histories.
Scope: account
------
Supported platforms:
- psn
- steamnetwork
- xbox
struct: 'PlatformAccountClosureHistoryService'
arguments:
params:
type: '*platform_account_closure_history.AdminGetUserPlatformAccountClosureHistoriesParams'
required: true
return_type: '(*platform_account_closure_history.AdminGetUserPlatformAccountClosureHistoriesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_history'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureHistory.go'
example: |-
platformAccountClosureHistoryService := gdpr.PlatformAccountClosureHistoryService{ ... }
params := platform_account_closure_history.AdminGetUserPlatformAccountClosureHistoriesParams{ ... }
res, err := platformAccountClosureHistoryService.AdminGetUserPlatformAccountClosureHistoriesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'closure'
- 'get'
- 'histories'
- 'history'
- 'platform'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER [READ]'
'AdminMockPlatformAccountClosureDataShort@go.gdpr.fun':
id: 'AdminMockPlatformAccountClosureDataShort@go.gdpr.fun'
name: 'AdminMockPlatformAccountClosureDataShort'
type: 'function'
description: |-
Mock platform account closure data.
-----
**This is only for testing**
Platform:
- steamnetwork
- xbox
- psn
Scope: account
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminMockPlatformAccountClosureDataParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminMockPlatformAccountClosureDataParams{ ... }
res, err := platformAccountClosureClientService.AdminMockPlatformAccountClosureDataShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'data'
- 'mock'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminRequestDataRetrievalShort@go.gdpr.fun':
id: 'AdminRequestDataRetrievalShort@go.gdpr.fun'
name: 'AdminRequestDataRetrievalShort'
type: 'function'
description: |-
Submit user personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.AdminRequestDataRetrievalParams'
required: true
return_type: '(*data_retrieval.AdminRequestDataRetrievalResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.AdminRequestDataRetrievalParams{ ... }
res, err := dataRetrievalService.AdminRequestDataRetrievalShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'data'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'AdminResetPlatformAccountClosureServicesConfigurationShort@go.gdpr.fun':
id: 'AdminResetPlatformAccountClosureServicesConfigurationShort@go.gdpr.fun'
name: 'AdminResetPlatformAccountClosureServicesConfigurationShort'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset registered platform account closure services configuration to use the default configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminResetPlatformAccountClosureServicesConfigurationParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminResetPlatformAccountClosureServicesConfigurationParams{ ... }
res, err := configurationService.AdminResetPlatformAccountClosureServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminResetServicesConfigurationShort@go.gdpr.fun':
id: 'AdminResetServicesConfigurationShort@go.gdpr.fun'
name: 'AdminResetServicesConfigurationShort'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset Registered Services Configuration to use the default configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminResetServicesConfigurationParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminResetServicesConfigurationParams{ ... }
res, err := configurationService.AdminResetServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminSubmitUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'AdminSubmitUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'AdminSubmitUserAccountDeletionRequestShort'
type: 'function'
description: |-
Submit user's account deletion request.
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.AdminSubmitUserAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion.AdminSubmitUserAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.AdminSubmitUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.AdminSubmitUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'request'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'AdminUpdatePlatformAccountClosureClientShort@go.gdpr.fun':
id: 'AdminUpdatePlatformAccountClosureClientShort@go.gdpr.fun'
name: 'AdminUpdatePlatformAccountClosureClientShort'
type: 'function'
description: |-
Update platform account closure client.
The namespace should be the **publisher or studio namespace**.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminUpdatePlatformAccountClosureClientParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminUpdatePlatformAccountClosureClientParams{ ... }
res, err := platformAccountClosureClientService.AdminUpdatePlatformAccountClosureClientShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'platform'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminUpdatePlatformAccountClosureServicesConfigurationShort@go.gdpr.fun':
id: 'AdminUpdatePlatformAccountClosureServicesConfigurationShort@go.gdpr.fun'
name: 'AdminUpdatePlatformAccountClosureServicesConfigurationShort'
type: 'function'
description: |-
Update registered platform account closure services configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminUpdatePlatformAccountClosureServicesConfigurationParams'
required: true
return_type: '(*configuration.AdminUpdatePlatformAccountClosureServicesConfigurationResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminUpdatePlatformAccountClosureServicesConfigurationParams{ ... }
res, err := configurationService.AdminUpdatePlatformAccountClosureServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminUpdateServicesConfigurationShort@go.gdpr.fun':
id: 'AdminUpdateServicesConfigurationShort@go.gdpr.fun'
name: 'AdminUpdateServicesConfigurationShort'
type: 'function'
description: |-
Update Registered Services Configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.AdminUpdateServicesConfigurationParams'
required: true
return_type: '(*configuration.AdminUpdateServicesConfigurationResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.AdminUpdateServicesConfigurationParams{ ... }
res, err := configurationService.AdminUpdateServicesConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminValidateXboxBPCertFileShort@go.gdpr.fun':
id: 'AdminValidateXboxBPCertFileShort@go.gdpr.fun'
name: 'AdminValidateXboxBPCertFileShort'
type: 'function'
description: |-
Check xbox BP cert file whether it's expired and return expiration date
struct: 'PlatformAccountClosureClientService'
arguments:
params:
type: '*platform_account_closure_client.AdminValidateXboxBPCertFileParams'
required: true
return_type: '(*platform_account_closure_client.AdminValidateXboxBPCertFileResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/platform_account_closure_client'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/platformAccountClosureClient.go'
example: |-
platformAccountClosureClientService := gdpr.PlatformAccountClosureClientService{ ... }
params := platform_account_closure_client.AdminValidateXboxBPCertFileParams{ ... }
res, err := platformAccountClosureClientService.AdminValidateXboxBPCertFileShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'admin'
- 'bp'
- 'cert'
- 'client'
- 'closure'
- 'file'
- 'platform'
- 'validate'
- 'xbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'DeleteAdminEmailConfigurationShort@go.gdpr.fun':
id: 'DeleteAdminEmailConfigurationShort@go.gdpr.fun'
name: 'DeleteAdminEmailConfigurationShort'
type: 'function'
description: |-
Delete a list of admin email addresses to stop receiving personal data request notification.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.DeleteAdminEmailConfigurationParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.DeleteAdminEmailConfigurationParams{ ... }
res, err := configurationService.DeleteAdminEmailConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'email'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [DELETE]'
'GetAdminEmailConfigurationShort@go.gdpr.fun':
id: 'GetAdminEmailConfigurationShort@go.gdpr.fun'
name: 'GetAdminEmailConfigurationShort'
type: 'function'
description: |-
Get list of admin email address configuration.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.GetAdminEmailConfigurationParams'
required: true
return_type: '(*configuration.GetAdminEmailConfigurationResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.GetAdminEmailConfigurationParams{ ... }
res, err := configurationService.GetAdminEmailConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'email'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [READ]'
'PublicCancelMyAccountDeletionRequestShort@go.gdpr.fun':
id: 'PublicCancelMyAccountDeletionRequestShort@go.gdpr.fun'
name: 'PublicCancelMyAccountDeletionRequestShort'
type: 'function'
description: |-
Cancel my account deletion request
Requires valid user access token
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicCancelMyAccountDeletionRequestParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicCancelMyAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.PublicCancelMyAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
'PublicCancelUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'PublicCancelUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'PublicCancelUserAccountDeletionRequestShort'
type: 'function'
description: |-
Cancel user's account deletion request
Requires valid user access token
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicCancelUserAccountDeletionRequestParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicCancelUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.PublicCancelUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'user'
'PublicCancelUserPersonalDataRequestShort@go.gdpr.fun':
id: 'PublicCancelUserPersonalDataRequestShort@go.gdpr.fun'
name: 'PublicCancelUserPersonalDataRequestShort'
type: 'function'
description: |-
Cancel user's personal data requests
Requires valid user access token
Scope: account
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.PublicCancelUserPersonalDataRequestParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.PublicCancelUserPersonalDataRequestParams{ ... }
res, err := dataRetrievalService.PublicCancelUserPersonalDataRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'cancel'
- 'data'
- 'personal'
- 'public'
- 'request'
- 'retrieval'
- 'user'
'PublicGeneratePersonalDataURLShort@go.gdpr.fun':
id: 'PublicGeneratePersonalDataURLShort@go.gdpr.fun'
name: 'PublicGeneratePersonalDataURLShort'
type: 'function'
description: |-
Generate personal data download url
Requires valid user access token
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.PublicGeneratePersonalDataURLParams'
required: true
return_type: '(*data_retrieval.PublicGeneratePersonalDataURLResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.PublicGeneratePersonalDataURLParams{ ... }
res, err := dataRetrievalService.PublicGeneratePersonalDataURLShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'generate'
- 'personal'
- 'public'
- 'retrieval'
- 'url'
'PublicGetMyAccountDeletionStatusShort@go.gdpr.fun':
id: 'PublicGetMyAccountDeletionStatusShort@go.gdpr.fun'
name: 'PublicGetMyAccountDeletionStatusShort'
type: 'function'
description: |-
Retrieve my account deletion status
Requires valid user access token
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicGetMyAccountDeletionStatusParams'
required: true
return_type: '(*data_deletion.PublicGetMyAccountDeletionStatusResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicGetMyAccountDeletionStatusParams{ ... }
res, err := dataDeletionService.PublicGetMyAccountDeletionStatusShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'my'
- 'public'
- 'status'
'PublicGetUserAccountDeletionStatusShort@go.gdpr.fun':
id: 'PublicGetUserAccountDeletionStatusShort@go.gdpr.fun'
name: 'PublicGetUserAccountDeletionStatusShort'
type: 'function'
description: |-
Retrieve specific user's account deletion status
Requires valid user access token
Scope: account
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicGetUserAccountDeletionStatusParams'
required: true
return_type: '(*data_deletion.PublicGetUserAccountDeletionStatusResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicGetUserAccountDeletionStatusParams{ ... }
res, err := dataDeletionService.PublicGetUserAccountDeletionStatusShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'public'
- 'status'
- 'user'
'PublicGetUserPersonalDataRequestsShort@go.gdpr.fun':
id: 'PublicGetUserPersonalDataRequestsShort@go.gdpr.fun'
name: 'PublicGetUserPersonalDataRequestsShort'
type: 'function'
description: |-
Get user's personal data requests
Requires valid user access token
Scope: account
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.PublicGetUserPersonalDataRequestsParams'
required: true
return_type: '(*data_retrieval.PublicGetUserPersonalDataRequestsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.PublicGetUserPersonalDataRequestsParams{ ... }
res, err := dataRetrievalService.PublicGetUserPersonalDataRequestsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'get'
- 'personal'
- 'public'
- 'requests'
- 'retrieval'
- 'user'
'PublicRequestDataRetrievalShort@go.gdpr.fun':
id: 'PublicRequestDataRetrievalShort@go.gdpr.fun'
name: 'PublicRequestDataRetrievalShort'
type: 'function'
description: |-
Submit personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
struct: 'DataRetrievalService'
arguments:
params:
type: '*data_retrieval.PublicRequestDataRetrievalParams'
required: true
return_type: '(*data_retrieval.PublicRequestDataRetrievalResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrieval.go'
example: |-
dataRetrievalService := gdpr.DataRetrievalService{ ... }
params := data_retrieval.PublicRequestDataRetrievalParams{ ... }
res, err := dataRetrievalService.PublicRequestDataRetrievalShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'public'
- 'request'
- 'retrieval'
'PublicSubmitMyAccountDeletionRequestShort@go.gdpr.fun':
id: 'PublicSubmitMyAccountDeletionRequestShort@go.gdpr.fun'
name: 'PublicSubmitMyAccountDeletionRequestShort'
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**
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicSubmitMyAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion.PublicSubmitMyAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicSubmitMyAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.PublicSubmitMyAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
- 'submit'
'PublicSubmitUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'PublicSubmitUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'PublicSubmitUserAccountDeletionRequestShort'
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**
struct: 'DataDeletionService'
arguments:
params:
type: '*data_deletion.PublicSubmitUserAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion.PublicSubmitUserAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletion.go'
example: |-
dataDeletionService := gdpr.DataDeletionService{ ... }
params := data_deletion.PublicSubmitUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionService.PublicSubmitUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'submit'
- 'user'
'S2SGeneratePersonalDataURLShort@go.gdpr.fun':
id: 'S2SGeneratePersonalDataURLShort@go.gdpr.fun'
name: 'S2SGeneratePersonalDataURLShort'
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
struct: 'DataRetrievalS2SService'
arguments:
params:
type: '*data_retrieval_s2_s.S2SGeneratePersonalDataURLParams'
required: true
return_type: '(*data_retrieval_s2_s.S2SGeneratePersonalDataURLResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrievalS2S.go'
example: |-
dataRetrievalS2SService := gdpr.DataRetrievalS2SService{ ... }
params := data_retrieval_s2_s.S2SGeneratePersonalDataURLParams{ ... }
res, err := dataRetrievalS2SService.S2SGeneratePersonalDataURLShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 's2s'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetDataRequestByRequestIDShort@go.gdpr.fun':
id: 'S2SGetDataRequestByRequestIDShort@go.gdpr.fun'
name: 'S2SGetDataRequestByRequestIDShort'
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
struct: 'DataRetrievalS2SService'
arguments:
params:
type: '*data_retrieval_s2_s.S2SGetDataRequestByRequestIDParams'
required: true
return_type: '(*data_retrieval_s2_s.S2SGetDataRequestByRequestIDResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrievalS2S.go'
example: |-
dataRetrievalS2SService := gdpr.DataRetrievalS2SService{ ... }
params := data_retrieval_s2_s.S2SGetDataRequestByRequestIDParams{ ... }
res, err := dataRetrievalS2SService.S2SGetDataRequestByRequestIDShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'by'
- 'data'
- 'get'
- 'id'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetListFinishedAccountDeletionRequestShort@go.gdpr.fun':
id: 'S2SGetListFinishedAccountDeletionRequestShort@go.gdpr.fun'
name: 'S2SGetListFinishedAccountDeletionRequestShort'
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
struct: 'DataDeletionS2SService'
arguments:
params:
type: '*data_deletion_s2_s.S2SGetListFinishedAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion_s2_s.S2SGetListFinishedAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletionS2S.go'
example: |-
dataDeletionS2SService := gdpr.DataDeletionS2SService{ ... }
params := data_deletion_s2_s.S2SGetListFinishedAccountDeletionRequestParams{ ... }
res, err := dataDeletionS2SService.S2SGetListFinishedAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'finished'
- 'get'
- 'list'
- 'request'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetListFinishedPersonalDataRequestShort@go.gdpr.fun':
id: 'S2SGetListFinishedPersonalDataRequestShort@go.gdpr.fun'
name: 'S2SGetListFinishedPersonalDataRequestShort'
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
struct: 'DataRetrievalS2SService'
arguments:
params:
type: '*data_retrieval_s2_s.S2SGetListFinishedPersonalDataRequestParams'
required: true
return_type: '(*data_retrieval_s2_s.S2SGetListFinishedPersonalDataRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrievalS2S.go'
example: |-
dataRetrievalS2SService := gdpr.DataRetrievalS2SService{ ... }
params := data_retrieval_s2_s.S2SGetListFinishedPersonalDataRequestParams{ ... }
res, err := dataRetrievalS2SService.S2SGetListFinishedPersonalDataRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'finished'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SRequestDataRetrievalShort@go.gdpr.fun':
id: 'S2SRequestDataRetrievalShort@go.gdpr.fun'
name: 'S2SRequestDataRetrievalShort'
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.
struct: 'DataRetrievalS2SService'
arguments:
params:
type: '*data_retrieval_s2_s.S2SRequestDataRetrievalParams'
required: true
return_type: '(*data_retrieval_s2_s.S2SRequestDataRetrievalResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_retrieval_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataRetrievalS2S.go'
example: |-
dataRetrievalS2SService := gdpr.DataRetrievalS2SService{ ... }
params := data_retrieval_s2_s.S2SRequestDataRetrievalParams{ ... }
res, err := dataRetrievalS2SService.S2SRequestDataRetrievalShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'data'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
'S2SSubmitUserAccountDeletionRequestShort@go.gdpr.fun':
id: 'S2SSubmitUserAccountDeletionRequestShort@go.gdpr.fun'
name: 'S2SSubmitUserAccountDeletionRequestShort'
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).
struct: 'DataDeletionS2SService'
arguments:
params:
type: '*data_deletion_s2_s.S2SSubmitUserAccountDeletionRequestParams'
required: true
return_type: '(*data_deletion_s2_s.S2SSubmitUserAccountDeletionRequestResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/data_deletion_s2_s'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/dataDeletionS2S.go'
example: |-
dataDeletionS2SService := gdpr.DataDeletionS2SService{ ... }
params := data_deletion_s2_s.S2SSubmitUserAccountDeletionRequestParams{ ... }
res, err := dataDeletionS2SService.S2SSubmitUserAccountDeletionRequestShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'account'
- 'data'
- 'deletion'
- 'request'
- 's2s'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
'SaveAdminEmailConfigurationShort@go.gdpr.fun':
id: 'SaveAdminEmailConfigurationShort@go.gdpr.fun'
name: 'SaveAdminEmailConfigurationShort'
type: 'function'
description: |-
Add admin email address for receiving personal data request notification.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.SaveAdminEmailConfigurationParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.SaveAdminEmailConfigurationParams{ ... }
res, err := configurationService.SaveAdminEmailConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'email'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [CREATE]'
'UpdateAdminEmailConfigurationShort@go.gdpr.fun':
id: 'UpdateAdminEmailConfigurationShort@go.gdpr.fun'
name: 'UpdateAdminEmailConfigurationShort'
type: 'function'
description: |-
Update admin email address for receiving personal data request notification.
Scope: account
struct: 'ConfigurationService'
arguments:
params:
type: '*configuration.UpdateAdminEmailConfigurationParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/gdpr-sdk/pkg/gdprclient/configuration'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/gdpr'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/gdpr/configuration.go'
example: |-
configurationService := gdpr.ConfigurationService{ ... }
params := configuration.UpdateAdminEmailConfigurationParams{ ... }
res, err := configurationService.UpdateAdminEmailConfigurationShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configuration'
- 'email'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [UPDATE]'
# endregion functions